fortytwo/php-sdk-two-factor-authentication

Fortytwo’s Two-Factor Authentication (2FA) API adds an additional layer of security to your users’ login credentials with a unique one-time code which limits the risk of fraudulent access to your website.

1.4.1 2016-09-15 12:49 UTC

Requires

• php: >=5.3.3
• fortytwo/php-sdk-core: 1.1.*

Requires (Dev)

• phpunit/phpunit: ^4.8

MIT

• Sebastien Lemarinel

• 2fa
• Two Factor Authentication
• 2 factor authentication
• fortytwo

README

This SDK help you to use the Two Factor Authentication service from FortyTwo Telecom

How to use it:

With composer:

Using composer:

    composer require fortytwo/php-sdk-two-factor-authentication

directly:

You can download the library from the Fortytwo Telecom website or on our official Github repository.

Testing:

Execute the following command on the project directory:

vendor/bin/phpunit -c tests/Phpunit.xml

Currently the code coverage is 100%.

API:

The SDK expose 2 main functions:

TwoFactorAuthentication::requestCode()

Parameters:

Name	Type	Required	Description
clientRef	String	Yes	Client reference.
phoneNumber	String	Yes	Destination Phone number.
optionalArgs	Array	No	List of optionals arguments

List of optionals arguments:

Name	Type	Default	Constraints	Description
codeLength	Integer	6	Maximum value 20	2FA Code
codeType	String	Numeric	alpha, numeric or alphanumeric	2FA Code type.
caseSensitive	Boolean	null	True or False	2FA Code case sensitive
callbackUrl	String	null	URL format withscheme (http/https)	2FA Callback URL.
senderId	String	null	-	Custom sender ID.
messageTemplate	String	null	{#TFA_CODE} Required	Custom message template

You can found a more detailled description of each parameter in the API documentation

TwoFactorAuthentication::validateCode()

Parameters:

Name	Type	Required	Description
clientRef	String	Yes	Client reference.
code	String	Yes	2FA Code.

You can found a more detailled description of each parameter in the API documentation