Getting Started with the Infusionsoft PHP SDK

Introduction

The Keap PHP SDK provides a simple way for you to get started with integrating usage of the Keap API into your application. Features include:

• Loading & installation of all files and dependencies via composer
• Built in helper functions to get started with OAuth 2.0 authentication
• Simple, normalized interface for accessing each function of the API

This tutorial will demonstrate how to install, setup, and use the Keap PHP SDK, including authenticating requests with OAuth 2.0

Install the SDK

We highly recommend using composer to manage installation of the Keap PHP SDK. To learn more about composer, check out the Composer getting started guide.

To install the SDK via the command line, simply run:

composer require infusionsoft/php-sdk

You can also manually add the dependency to your composer.json file:

{
    "require": {
        "infusionsoft/php-sdk": "dev-master"
    }
}

You're all set! If you're not using a PHP framework that is already autoloading your Composer vendor directory, you'll also want to include the following at the start of your PHP file:

require_once 'vendor/autoload.php';

Create an Infusionsoft API Object

For the next step you're going to need your Keap API client ID and client secret. Don't have them? You can create API credentials for free in just a few minutes here.

Let's create a new Keap API object:

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

You're may be wondering what the redirectUri argument is. When your application asks a user for permission to access their Keap data, Keap has to know where to redirect that user after they've allowed (or denied) permission to your application to make requests. If you're developing locally, feel free to use the local URL of your app (Keap will redirect to that without complaining).

Check for an access token

The next few steps are going to seem backwards, but will make sense at the end.

In order to make requests to the API, we use an access token to prove who we are and which Infusionsoft customer we're acting on behalf of. We'll go through the steps to retrieve an access token in a moment, but for now, a) we want to check if we have the access token, and b) if we do have an access token, save it in the PHP session so we can use it again later. We can accomplish this in just few lines of code:

if (isset($_SESSION['token'])) {
    $infusionsoft->setToken(unserialize($_SESSION['token']));
}

In other words, if we've already saved the token in the PHP session, retrieve that data from the session, unserialize it, and reset it to the Keap object.

Request an access code and exchange it for an access token

if (isset($_GET['code']) and !$infusionsoft->getToken()) {
    $infusionsoft->requestAccessToken($_GET['code']);
}

if ($infusionsoft->getToken()) {
    $_SESSION['token'] = serialize($infusionsoft->getToken());

    $infusionsoft->contacts->add(array('FirstName' => 'John', 'LastName' => 'Doe'));
} else {
    echo '<a rel="nofollow" href="' . $infusionsoft->getAuthorizationUrl() . '">Click here to authorize</a>';
}

Let's start with line 5. If we already have an access token set on the Keap object, we can make a request to the API (in this case, add "John Doe" to our contacts list). If we don't have an access token, we need to provide the user a way to authenticate with Keap. This is accomplished by providing a link to the authorization URL, which you can retrieve with $infusionsoft->getAuthorizationUrl().

Once a user has clicked the link and given permission for your application to use the Keap API on their behalf, the user will be redirected back to your application (they'll be sent to the URL you specified as the redirectUri parameter when you first instantiated the Infusionsoft class).

Now we're at the beginning of this code example - when the user is sent back to the redirectUri location, there will be some additional data appended to the query string. The code parameter is the value you'll use to request an access token, and you can do this by passing it to the $infusionsoft->requestAccessToken() method. The SDK will automatically assign the access token to the $infusionsoft object, and then it will be saved on line 6 before trying to add our new contact, John Doe.

That's it! You've now successfully connected to the Keap API using the PHP SDK, and can continue to make requests for the duration of the user's session.