ahmedhat/unifonic-authenticate

Handles verifications with OTP to multiple channels

dev-master 2021-04-29 10:36 UTC

Requires

• php: >=5.4.0
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• apimatic/jsonmapper: ^1.3.1
• apimatic/unirest-php: ^2.0.0

Requires (Dev)

• squizlabs/php_codesniffer: ^2.7

MIT

• Unifonic Support

• api
• sdk
• Unifonic Authenticate

README

Handles verifications with OTP to multiple channels

How to Build

The generated code has dependencies over external libraries like UniRest. These dependencies are defined in the `composer.jsonfile that comes with the SDK. To resolve these dependencies, we use the Composer package manager which requires PHP greater than 5.3.2 installed in your system. Visit [https://getcomposer.org/download/](https://getcomposer.org/download/) to download the installer file for Composer and run it in your system. Open command prompt and typecomposer --version`. This should display the current version of the Composer installed if the installation was successful.

• Using command line, navigate to the directory containing the generated files (including `composer.json`) for the SDK.
• Run the command `composer install`. This should install all the required dependencies and create the `vendor` directory in your project directory.

[For Windows Users Only] Configuring CURL Certificate Path in php.ini

CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:

1. Download the certificate bundle (.pem file) from https://curl.haxx.se/docs/caextract.html on to your system.
2. Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file.

[curl]
; A default value for the CURLOPT_CAINFO option. This is required to be an
; absolute path.
;curl.cainfo =

How to Use

The following section explains how to use the UnifonicAuthenticate library in a new project.

1. Open Project in an IDE

Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on `Openin PhpStorm to browse to your generated SDK directory and then clickOK`.

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Name the directory as "test"

Add a PHP file to this project

Name it "testSDK"

Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes.

require_once "../vendor/autoload.php";

It is important that the path inside require_once correctly points to the file `autoload.php` inside the vendor directory created during dependency installations.

After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

3. Run the Test Project

To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer.

Open `SettingsfromFile` menu.

Select `PHPfrom withinLanguages & Frameworks`

Browse for Interpreters near the `Interpreter` option and choose your interpreter.

Once the interpreter is selected, click `OK`

To run your project, right click on your PHP file inside your Test project and click on `Run`

How to Test

Unit tests in this SDK can be run using PHPUnit.

1. First install the dependencies using composer including the require-dev dependencies.
2. Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

Parameter	Description
xAuthenticateAppId	TODO: add a description
authorization	Bearer Auth Token

API client can be initialized as following.

$xAuthenticateAppId = 'xAuthenticateAppId';
$authorization = 'Bearer AUTH_TOKEN'; // Bearer Auth Token

$client = new UnifonicAuthenticateLib\UnifonicAuthenticateClient($xAuthenticateAppId, $authorization);

Class Reference

List of Controllers

• VerificationsController

VerificationsController

Get singleton instance

The singleton instance of the VerificationsController class can be accessed from the API Client.

$verifications = $client->getVerifications();

createCheckVerification

TODO: Add a method description

function createCheckVerification(
        $to,
        $channel,
        $code)

Parameters

Parameter	Tags	Description
to	Required	Address of receiver
channel	Required	Channel you want to send. Possible values are sms, whatsapp & voice.
code	Required	The code which user has entered

Example Usage

$to = 'to';
$channel = 'channel';
$code = 'code';

$result = $verifications->createCheckVerification($to, $channel, $code);

Errors

Error Code	Error Description
400	bad input parameter

createVerification

This endpoint sends a verification code through any of channels mainly Sms, Voice & Whatsapp. By default it sends messages to all configured channels in the Authenticate app.

function createVerification(
        $to,
        $channel = null,
        $locale = 'en',
        $length = null)

Parameters

Parameter	Tags	Description
to	Required	Address of receiver
channel	Optional	Channel you want to use for sending verification code. Currently there are three channels SMS, Voice & Whatsapp. Their priorities can be defined in Unifonic Authenticate configuration panel. By default it will send verification through all of configured channels. If channel is not defined the verification code will be sent on the basis of priority defined for each channel.
locale	Optional DefaultValue	In what language you want to send
length	Optional	Length of verification code

Example Usage

$to = 'to';
$channel = 'channel';
$locale = 'en';
$length = 'length';

$result = $verifications->createVerification($to, $channel, $locale, $length);

Errors

Error Code	Error Description
400	bad input parameter

Back to List of Controllers