index.en.md

Description:

Genius Referrals in a intent to improve the integration process with its clients has created this library. Which allows customers to consume, using PHP, all Genius Referrals RESTful API resources located at http://api.geniusreferrals.com/doc/.

Installation:

The installation process for this client in very simple and you can do it using different ways.

Using Composer

We recommend to use composer to install the client.

1- Install Composer

cd into the directory of your project (eg: my_project) and run:

curl -sS https://getcomposer.org/installer | php

2- Add the GRAPIPHPClient package as a dependency by running:

php composer.phar require geniusreferrals/gr-api-php-client:dev-master

3- Require Composer's autoloader

require_once '../vendor/autoload.php';

Using Git

1- Clone the repo

If you don't want to use composer you can install the package by cloning the git repo. cd into the folder you want to save the package in and run:

git clone git@github.com:GeniusReferrals/GRAPIPHPClient.git

2- Require the client class on the class you want to use the client.

require_once 'src/GeniusReferrals/GRPHPAPIClient.php';

Downloading the GRAPIPHPClient client

1- Download the package manually

Download the zip client using this link GRAPIPHPClient, unzip the package and save it in a folder under your project directory.

2- Require the client class on the class you want to use the client.

require_once 'src/GeniusReferrals/GRPHPAPIClient.php';

Using the Client

<?php

require_once '../vendor/autoload.php';

use GeniusReferrals\GRPHPAPIClient;

// Create a new GRPHPAPIClient object
$objGeniusReferralsAPIClient = new GRPHPAPIClient('YOUR_USERNAME', 'YOUR_API_TOKEN');

//Test authentication
$jsonResponse = $objGeniusReferralsAPIClient->testAuthentication();

// Get the list of Genius Referrals client accounts
$jsonResponse = $objGeniusReferralsAPIClient->getAccounts();

// Get the response from the previous request
$aryResponse = json_decode($jsonResponse);

// Get the response code from the previous request
$intResponseCode = $objGeniusReferralsAPIClient->getResponseCode();

// Create new advocate
$aryAdvocate = array('advocate' => array("name" => "Jonh", "lastname" => "Smith", "email" => "jonh@email.com", "payout_threshold" => 10));
$objGeniusReferralsAPIClient->postAdvocate('example-com', $aryAdvocate);

// Get the response code from the previous request
$intResponseCode = $objGeniusReferralsAPIClient->getResponseCode();
 

More examples

We have implemented more examples to show you how to utilize the client. Please check them out here Integration examples.

For you to be able to test the examples you must substitute the parameters YOUR_USERNAME y YOUR_API_TOKEN with the proper username and api token assigned to you on Genius Referrals platform.

Unit testing

The client uses PHPUnit for unit testing. In order to run the unit tests, you'll first need to install the dependencies of the project using Composer: php composer.phar install --dev.

You can then run the tests using using the following command at the project root:

phpunit -c vendor/geniusreferrals/gr-api-php-client/

If you are running the tests with xdebug enabled, you may encounter the following issue: Fatal error: Maximum function nesting level of '100' reached, aborting!. This can be resolved by adding xdebug.max_nesting_level = 200 to your php.ini file.

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker.