gufy/whmcs

WHMCS API for Laravel 5

Laravel WHMCS API

Important Notes

For Laravel 4, please refer to this notes. Click Here, _(*1)

Laravel 5 - Simple package for WHMCS external API., _(*2)

Installation

Run this to install on your current project, _(*3)

$ composer require gufy/whmcs:~2

Or you can add this package to your composer.json file:, _(*4)

"require": {
    "gufy/whmcs": "~2"
}

Use composer to install this package., _(*5)

$ composer update

Configuration

Registering the Package

register this service provider at the bottom of the $providers array: app.php, _(*6)

'Gufy\Whmcs\WhmcsServiceProvider'

Publish the configuration

When this command is executed, the configuration files for your application will be copied to app/config/packages/gufy/whmcs where they can be safely modified by the developer!, _(*7)

php artisan vendor:publish gufy/whmcs

Setting you API URL

go to config/whmcs.php and set the parameters, _(*8)

return array(

    'username'      =>  'api-username',
    'password'      =>  'api-password', // fill these if you want to use username password
    'auth_type'     =>  'password', // password or api_key
    'url'           =>  'http://www.site.com/whmcs/includes/api.php', // API url
    'response'  => 'object', // you can fill with either object or array
);

Usage

Basic usage

Logging a user to WHMCS, _(*9)

$username = 'client';   // Client Username
$password = 'password'; // Client Password

$login = Whmcs::execute('validatelogin', array(
    'email' => $username,
    'password2' => $password
));

// or

$login = Whmcs::validatelogin(array(
    'email' => $username,
    'password2' => $password
));

if($login->result == 'success') {
    echo 'User Logged In';
} elseif($login->result == 'error') {
    echo $login->message;
}

For reference on WHMCS API please follow http://docs.whmcs.com/API, _(*10)

Dynamic Configuration

If your site has multiple whmcs configuration, you sure will do override configuration like this, _(*11)

\Config::set('whmcs.url','http://whmcs.site.com/includes/api.php');
\Config::set('whmcs.password','your_password');
\Config::set('whmcs.username','your_username');