panlogic/fonix

Fonix.io PHP library helper

1.0.5 2018-06-02 14:06 UTC

This package is auto-updated.

Last update: 2024-11-16 03:12:12 UTC


README

Fonix is a PHP library class to make using the Fonix API easy

Latest Stable Version Total Downloads Latest Unstable Version License

Composer

To install Fonix as a Composer package, simply add this to your composer.json:

"panlogic/fonix": "dev-master"

..and run composer update. Once it's installed, if you're using Laravel 5, you can register the service provider in app/config/app.php in the providers array add :

'Panlogic\Fonix\FonixServiceProvider',

You can also benefit from using a Fonix Facade in Laravel 5 by adding to the alias array also in app.php below the providers array

'Fonix'    => 'Panlogic\Fonix\Facades\FonixFacade',

Documentation

If you're using Laravel, publish the config file by running

php artisan vendor:publish

This will create a panlogic.fonix.php file in your Config directory, be sure to fill in the appropriate details provided by Fonix in your env file.

FONIX_API_KEY_LIVE= FONIX_API_KEY_TEST= FONIX_PLATFORM= FONIX_ORIGINATOR=

If you aren't using Laravel then you can create a Fonix object by:

use Panlogic\Fonix\Fonix;

$config = [
	'live_apikey' 		=> 'your-live-api-key-here',
	'test_apikey' 		=> 'your-test-api-key-here',
	'platform' 			=> 'test',
	'originator' 		=> '123456', //short code
];

$fonix = new Fonix($config);

For more information about how to use the Fonix class, read the Wiki

Copyright and Licence

Fonix has been written by Panlogic Ltd and is released under the MIT License.