This is the official PHP wrapper for the ActiveCampaign API. The purpose of these files is to provide a simple interface to the ActiveCampaign API. You are not required to use these files (in order to use the ActiveCampaign API), but it's recommended for a few reasons:
- It's a lot easier to get set up and use (as opposed to coding everything from scratch on your own).
- It's fully supported by ActiveCampaign, meaning we fix any issues immediately, as well as continually improve the wrapper as the software changes and evolves.
- It's often the standard approach for demonstrating API requests when using ActiveCampaign support.
Both customers of our hosted platform and On-Site edition can use these files. On-Site customers should clone the source and switch to the "onsite" branch, as that is geared towards the On-Site edition. Many features of the hosted platform are not available in the On-Site edition.
You can install activecampaign-api-php by downloading (.zip) or cloning the source:
git clone git@github.com:ActiveCampaign/activecampaign-api-php.git
If you are using Composer, create your composer.json file (example here).
Then load the composer.phar file in that directory:
curl -sS https://getcomposer.org/installer | php
Next, run install to load the ActiveCampaign library:
php composer.phar install
You should then see the activecampaign folder inside vendor.
Read more about using Composer.
In your script just include the autoload.php file to load all classes:
require "vendor/autoload.php";
Next, create a class instance of ActiveCampaign:
$ac = new ActiveCampaign("API_URL", "API_KEY");
That's it!
define("ACTIVECAMPAIGN_URL", "API_URL");
define("ACTIVECAMPAIGN_API_KEY", "API_KEY");
require_once("includes/ActiveCampaign.class.php");
$ac = new ActiveCampaign(ACTIVECAMPAIGN_URL, ACTIVECAMPAIGN_API_KEY);
// Adjust the default cURL timeout
$ac->set_curl_timeout(10);
$account = $ac->api("account/view");
Or just include everything in the same PHP file:
define("ACTIVECAMPAIGN_URL", "API_URL");
define("ACTIVECAMPAIGN_API_KEY", "API_KEY");
require_once("includes/ActiveCampaign.class.php");
$ac = new ActiveCampaign(ACTIVECAMPAIGN_URL, ACTIVECAMPAIGN_API_KEY);
// Adjust the default cURL timeout
$ac->set_curl_timeout(10);
$account = $ac->api("account/view");
See our examples file for more in-depth samples.
Click here to view our full API documentation.
We'd love to help if you have questions or problems. Report issues using the Github Issue Tracker or email help@activecampaign.com.