trafik8787/sms-verification-laravel

Provides endpoints for sending SMS to some phone number and it's verifying.

0.9.4 2017-09-19 17:39 UTC

Requires

• php: >=5.5
• guzzlehttp/guzzle: 6.1.*

Requires (Dev)

• phpunit/phpunit: 4.*

MIT

• Michael Kelner

• sms
• laravel
• laravel 5
• phone verification

README

This library contains a set of two simple server endpoints for doing phone number verification via SMS.

SMS is done via phone.com API and in fact this code is intended to demonstrate real world use-case for using the phone.com API. All available Phone.com API's are defined at https://apidocs.phone.com.

Server is written in PHP using the Laravel framework.

##Installation

Once this library is installed you need to register the service provider. Open config/app.php and find the providers key.

'providers' => [
    ...
    \Phonedotcom\SmsVerification\SmsVerificationProvider::class,
    ...
]

Run the command:

php artisan vendor:publish --provider="Phonedotcom\SmsVerification\SmsVerificationProvider" --tag=config

Add SMS Verification endpoints to your routing file:

\Phonedotcom\SmsVerification\SmsVerificationProvider::registerRoutes($router);

The process for SMS verification is as follow:

1. Use the POST /sms-verification to send the code to a mobile device
2. Use the GET /sms-verification/{code}/{mobilePhoneNumber} to verify the code

For example, if an app wants to send an authorization code to a cell phone [phone]

1. Send a POST /sms-verification API to URL https://api.example.com/sms-verification with JSON body {"phone_number" : "[phone]"}
2. The API returns {"success":true,"description":"OK","expires_at": 1495120612} if the code is sent. expires_at is actual time of code expiration.
3. The cell phone will receive a 6-digit code (for example: 782025)
4. In order to verify the code, send a Get /sms-verification API to https://api.example.com/sms-verification/782025/[phone]
5. The API returns:
   • On success: {"success":true,"description":"OK","expires_at": 1495120612}
   • On failure: {"success":false,"description":"Wrong code"}

Errors

If an exception was thrown during the SMS verification process, output contains field error.

• 1XX - code validation error
• 2XX - something is not configured
• 3XX - input format validation was failed
• 5XX - code generating error
• 4XX - code sending error
• 999 - any other server error, not related to SMS Verification library

Notes

1. The authorization code sent is only valid for 10 minutes
2. The code can be verified only once. After the first success, it will be invalidated