Download the PHP package cecula/vereafy-laravel without Composer
On this page you can find all versions of the php package cecula/vereafy-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cecula/vereafy-laravel
More information about cecula/vereafy-laravel
Files in cecula/vereafy-laravel
Package vereafy-laravel
Short Description This package is to enable Laravel Developers integrate seamlessly with the Vereafy API
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package vereafy-laravel
Vereafy Laravel Library
- Introduction
- Initialization
- Completion
- Resend
- Get Balance
- Error Responses
Introduction:
Vereafy is an SMS based 2-factor authentication services that uses machine learning to understand the causes of OTP delivery failures and resolves them instantly to ensure your login and sign up OTPs deliver.
The Vereafy Laravel Library Project was created to enable Laravel Developers integrate seamlessly with the Vereafy API.
To use the Vereafy Laravel library, you just need to clone this repo into your existing project directory and do composer install in other to install the dependency
How to Get API Key
Your API Key is first generated when you register an app. To register an app, Login to the Developers Dashboard, Navigate to Apps > Add, Type the name of your app and click Submit. The app will be registered and a new API Key will be generated. Copy the API key into your project
or
Click developer.cecula.com to get started
To Integrate Differently
Place this at the top of your file :
Initialization
The Vereafy 2FA initialization can be as simple as the following lines of code:
The initialization method returns a response that should look like this:
Completion
The Vereafy 2FA completion can be as simple as the following lines of code:
The completion method returns a response that should look like this if the parameters are correct:
Resend
In a case where your app users get impatient and hits the retry link on your app form, just call the resend method this way:
The resend method returns a response that should look like this:
Get Balance
To get your balance on Vereafy, the getbalance method is used this way:
The method requires no parameter, and the returned response should look like this:
Error Responses
In a case where the request fails due to one reason or another you should get an error response from the requested endpoint that looks like this:
The table below shows a list of error codes and their descriptions
| Error Code | Description |
|---|---|
| CE1001 | Missing Fields |
| CE1002 | Empty Fields |
| CE1006 | Not a Nigerian Number |
| CE2000 | Invalid PIN Ref |
| CE2002 | PIN does not reference any verification request |
| CE2003 | Mobile number does not match original request |
| CE2001 | Invalid PIN |
| CE2004 | Request Not Found |
| CE7000 | Verification already succeeded |
| CE7001 | Verification already failed |
| CE6000 | Insufficient Balance |
| CE5000 | Invalid Template ID |
| CE5001 | Could not find referenced template |
