infusionsoft/php-sdk

PHP SDK for the Infusionsoft

Infusionsoft PHP SDK

[!WARNING] ⚠️ Deprecated This SDK is no longer actively maintained. Please migrate to the replacement: keap-sdk-php, available on Packagist., _(*1)

You can use the Migration guide from infusionsoft/php-sdk., _(*2)

, _(*3)

Version Notes

This version implements RESTful endpoints, a new version of Guzzle, and a restructured request handler., _(*4)

As of version 1.6, PHP 8.1+ is required., _(*5)

Breaking Change

With the Guzzle 7 upgrade, there was a refactor on the request function name in Infusionsoft\Http\ClientInterface. If you created a custom HttpClient, you'll need to update to use the new function name of call, _(*6)

If you use the Contacts, Orders or Products services, there are now two different classes handling each service - one for REST, one for XML-RPC. This version of the SDK will load the REST class by default. If you still need the XML-RPC class, pass 'xml' as an argument when requesting the object: $infusionsoft->orders('xml')', _(*7)

Kudos to toddstoker and mattmerrill for their contributions to this release., _(*8)

Install

Using the composer CLI:, _(*9)

composer require infusionsoft/php-sdk

Or manually add it to your composer.json:, _(*10)

``` json { "require": { "infusionsoft/php-sdk": "1.6.*" } }, <sub>(*11)</sub>

## Authentication

Currently Keap supports two types of authentication for our APIs: the OAuth2 Access Code Grant and API Keys.  
Developers of third-party integrations should always use our OAuth2 authentication, but developers building integrations for a single tenant may find the use of API Keys much simpler.

### OAuth2 Access Code Grant

The client ID and secret are the key and secret for your OAuth2 application found at the [Infusionsoft Developers](https://keys.developer.keap.com) website.

```php

if(empty(session_id();)) session_start();

require_once 'vendor/autoload.php';

$infusionsoft = new \Infusionsoft\Infusionsoft(array(
    'clientId'     => 'XXXXXXXXXXXXXXXXXXXXXXXX',
    'clientSecret' => 'XXXXXXXXXX',
    'redirectUri'  => 'http://example.com/',
));

// If the serialized token is available in the session storage, we tell the SDK
// to use that token for subsequent requests.
if (isset($_SESSION['token'])) {
    $infusionsoft->setToken(unserialize($_SESSION['token']));
}

// If we are returning from Infusionsoft we need to exchange the code for an
// access token.
if (isset($_GET['code']) and !$infusionsoft->getToken()) {
    $_SESSION['token'] = serialize($infusionsoft->requestAccessToken($_GET['code']));
}

if ($infusionsoft->getToken()) {
    // Save the serialized token to the current session for subsequent requests
    $_SESSION['token'] = serialize($infusionsoft->getToken());

    // MAKE INFUSIONSOFT REQUEST
} else {
    echo '<a href="' . $infusionsoft->getAuthorizationUrl() . '">Click here to authorize</a>';
}

API Keys

API Keys are a "password" for your data in an application and should always be treated like a dangerous secret., <sub>(*12)</sub>

In our UI you will find an API Settings screen which divides API Keys into two distinct categories: * Personal Access Tokens, which are scoped to your own user account and can only see and manipulate the data you have access to. * Service Account Keys, which can only be authorized by an Administrator and have full access to the data stored in the application., <sub>(*13)</sub>

For additional information on how to authorize and use PATs and SAKs please see our developer documentation., <sub>(*14)</sub>

require_once 'vendor/autoload.php';

$infusionsoft = new \Infusionsoft\Infusionsoft(array(
  'apikey' => $APIKeyRetrievedFromCredentialStorage,
));

// MAKE INFUSIONSOFT REQUEST

Making XML-RPC Requests

require_once 'vendor/autoload.php';

//
// Setup your Infusionsoft object here, then set your token either via the request or from storage
// As of v1.3 contacts defaults to rest
$infusionsoft->setToken($myTokenObject);

$infusionsoft->contacts('xml')->add(array('FirstName' => 'John', 'LastName' => 'Doe'));

Making REST Requests

The PHP SDK is setup to allow easy access to REST endpoints. In general, a single result is returned as a Class representing that object, and multiple objects are returned as an Infusionsoft Collection, which is simply a wrapper around an array of results making them easier to manage., <sub>(*15)</sub>

The standard REST operations are mapped to a series of simple functions. We'll use the Tasks service for our examples, but the operations below work on all documented Infusionsoft REST services., <sub>(*16)</sub>

To retrieve all tasks:, <sub>(*17)</sub>

php $tasks = $infusionsoft->tasks()->all();, <sub>(*18)</sub>

To retrieve a single task:, <sub>(*19)</sub>

php $task = $infusionsoft->tasks()->find($taskId);, <sub>(*20)</sub>

To query only completed tasks:, <sub>(*21)</sub>

php $tasks = $infusionsoft->tasks()->where('status', 'completed')->get();, <sub>(*22)</sub>

You can chain where() as many times as you'd like, or you can pass an array:, <sub>(*23)</sub>

php $tasks = $infusionsoft->tasks()->where(['status' => 'completed', 'user_id' => '45'])->get();, <sub>(*24)</sub>

To create a task: php $task = $infusionsoft->tasks()->create([ 'title' => 'My First Task', 'description' => 'Better get it done!' ]);, <sub>(*25)</sub>

Then update that task: php $task->title = 'A better task title'; $task->save();, <sub>(*26)</sub>

And finally, to delete the task: php $task->delete();, <sub>(*27)</sub>

Several REST services have a /sync endpoint, which we provide a helper method for: php $tasks = $infusionsoft->tasks()->sync($syncId);, <sub>(*28)</sub>

This returns a list of tasks created or updated since the sync ID was last generated., <sub>(*29)</sub>

require_once 'vendor/autoload.php';

//
// Setup your Infusionsoft object here, then set your token either via the request or from storage
//
$infusionsoft->setToken($myTokenObject);

$infusionsoft->tasks()->find('1');

Dates

DateTime objects are used instead of a DateTime string where the date(time) is a parameter in the method., <sub>(*30)</sub>

$datetime = new \DateTime('now',new \DateTimeZone('America/New_York'));

Debugging

To enable debugging of requests and responses, you need to set the debug flag to try by using:, <sub>(*31)</sub>

$infusionsoft->setDebug(true);

Once enabled, logs will by default be written to an array that can be accessed by:, <sub>(*32)</sub>

$infusionsoft->getLogs();

You can utilize the powerful logging plugin built into Guzzle by using one of the available adapters. For example, to use the Monolog writer to write to a file:, <sub>(*33)</sub>

use Monolog\Handler\StreamHandler;
use Monolog\Logger;

$logger = new Logger('client');
$logger->pushHandler(new StreamHandler('infusionsoft.log'));

$infusionsoft->setHttpLogAdapter($logger);

Testing

``` bash $ phpunit, <sub>(*34)</sub>

## Laravel Framework Support

### Laravel < 5.5

In config/app.php, register the service provider

Infusionsoft\FrameworkSupport\Laravel\InfusionsoftServiceProvider::class,, <sub>(*35)</sub>

Register the Facade (optional)

'Infusionsoft' => Infusionsoft\FrameworkSupport\Laravel\InfusionsoftFacade::class, <sub>(*36)</sub>

### Laravel >= 5.5

In Laravel 5.5, package auto-discovery was added. The service provider and facade will be detected for you. Continue by publishing the vendor assets and adding your env variables.

Publish the config

php artisan vendor:publish --provider="Infusionsoft\FrameworkSupport\Laravel\InfusionsoftServiceProvider", <sub>(*37)</sub>

Set your env variables

INFUSIONSOFT_CLIENT_ID=xxxxxxxx INFUSIONSOFT_SECRET=xxxxxxxx INFUSIONSOFT_REDIRECT_URL=http://localhost/auth/callback, <sub>(*38)</sub>

Access Infusionsoft from the Facade or Binding

$data = Infusionsoft::data()->query("Contact",1000,0,['Id' => '123'],['Id','FirstName','LastName','Email'], 'Id', false);, <sub>(*39)</sub>

$data = app('infusionsoft')->data()->query("Contact",1000,0,['Id' => '123'],['Id','FirstName','LastName','Email'], 'Id', false);, <sub>(*40)</sub>

## Lumen Service Provider

In bootstrap/app.php, register the service provider

$app->register(Infusionsoft\FrameworkSupport\Lumen\InfusionsoftServiceProvider::class);, <sub>(*41)</sub>

Set your env variables (make sure you're loading your env file in app.php)

INFUSIONSOFT_CLIENT_ID=xxxxxxxx INFUSIONSOFT_SECRET=xxxxxxxx INFUSIONSOFT_REDIRECT_URL=http://localhost/auth/callback, <sub>(*42)</sub>

Access Infusionsoft from the Binding

$data = app('infusionsoft')->data()->query("Contact",1000,0,['Id' => '123'],['Id','FirstName','LastName','Email'], 'Id', false);, <sub>(*43)</sub>

## SDK Development
You can install the Composer dependencies without installing Composer:

docker compose run composer, <sub>(*44)</sub>

You can access the samples by spinning up the Docker container for the Composer dependencies:

docker compose up -d, <sub>(*45)</sub>

Tests can be executed without installing PHP in the host environment (while the main container is running):

docker exec -it infusionsoft-php /var/www/html/vendor/bin/phpunit tests ```, <sub>(*46)</sub>

If using Docker for Windows, please see .env for additional details., <sub>(*47)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*48)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*49)</sub>