ivanhoe/ivanhoe-sdk

PHP sdk for replacing affiliate links

Ivanhoe-php-SDK

##Installation

``` sh $ composer require ivanhoe/ivanhoe-sdk, <sub>(*1)</sub>

## Basic Usage
### Create a user session and get sub id
-----------
``` php
$httpClient = new \Ivanhoe\SDK\CurlClient();
$sessionResource = new Ivanhoe\SDK\SessionResource($httpClient);

$subId = $sessionResource->setCredentials(['id', 'password'])
    ->getSubId();

This method will send user data to Ivanhoe server and return a generated sub id. But you can pass custom body parameters to SessionResource::getSubId to override user info., <sub>(*2)</sub>

Able parameters are:

hostname - Your website hostname with a protocol., <sub>(*3)</sub>

user_agent - Valid user agent., <sub>(*4)</sub>

user_ip - Valid ipv4 or ipv6., <sub>(*5)</sub>

referrer - The traffic source., <sub>(*6)</sub>

document_path., <sub>(*7)</sub>

language - Two characters that means a user language., <sub>(*8)</sub>

google_client_id - Google analytics client id from [_ga] cookie. Can be get within a helper Analitycs, <sub>(*9)</sub>

Example:, <sub>(*10)</sub>

``` php $httpClient = new \Ivanhoe\SDK\CurlClient(); $sessionResource = new Ivanhoe\SDK\SessionResource($httpClient);, <sub>(*11)</sub>

$subId = $sessionResource->setCredentials(['id', 'password']) ->getSubId([ 'hostname' => 'http://test.com', // google analytics profile id // https://developers.google.com/analytics/devguides/collection/analyticsjs/cookies-user-id 'google_client_id' => Ivanhoe\SDK\Analytics::getProfileId(), ]);, <sub>(*12)</sub>

### Setting options

You are able to set curl options on CurlClient::setOpts method. The keys are curl option constants.

-----------
``` php
$httpClient = new \Ivanhoe\SDK\CurlClient();
$httpClient->setOpts([
    CURLOPT_FRESH_CONNECT => true
]);