Developed for Examine.com, (*1)
ConvertKit API Wrapper
SDK for the ConvertKit V3 API, (*2)
Based on original documentation located here: http://kb.convertkit.com/article/api-documentation-v3/, (*3)
composer is the recommended way to install the SDK., (*4)
It is available at https://packagist.org. To use it in your project, you need to include it as a dependency in your project composer.json file., (*5)
Installation
-
Download Composer if not already installed, (*6)
-
Go to your project directory. If you do not have one, just create a directory and cd in., (*7)
mkdir project
cd project
-
Execute composer require "examinecom/convertkit:*" on command line. Replace composer with composer.phar if required. It should show something like this:, (*8)
> composer require "examinecom/convertkit:*"
Loading composer repositories with package information
Updating dependencies (including require-dev)
- Installing examinecom/convertkit (0.1)
Loading from cache
Writing lock file
Generating autoload files
How to use
-
Make sure you are auto-loading Composer in your bootstrap file or main php file:, (*9)
require_once __DIR__ . '/vendor/autoload.php';
-
In your class or PHP file, include the namespace of the class:, (*10)
use \Examinecom\ConvertKit\ConvertKit;
-
In your constructor or wherever you want to instantiate / use the API, create a new instance of the class and use your APP_ID and API_KEY as the parameters:, (*11)
$this->client = new ConvertKit("{API_KEY}", "{API_SECRET}");
-
Call one of the methods to access the API:, (*12)
$response = $this->client->tags()->all();
var_dump($response);
Sample code
<?php
namespace App;
use \Examinecom\ConvertKit\ConvertKit;
require_once __DIR__ . '/vendor/autoload.php';
class ConvertKitApp
{
/* Properties
-------------------------------*/
private $client = null;
public function __construct($apiKey, $apiSecret)
{
$this->client = new ConvertKit($apiKey, $apiSecret);
}
public function getTags()
{
$response = $this->client->tags()->all();
return $response;
}
}
$convertKit = new ConvertKitApp("APP_ID", "API_KEY");
$tags = $convertKit->getTags();
var_dump($tags);
Wallogit.com
