README

这个库是 ActiveCampaign API v3 的简单 PHP 封装。

安装

使用 Composer 安装最新版本

composer require metaline/activecampaign-sdk

需求

此项目与 PHP 5.6+ 或 7.1+ 兼容。

您还需要一个 URL 和一个密钥来访问 ActiveCampaign API。这些参数是您 ActiveCampaign 账户特有的。您可以在您的个人资料设置/开发者部分找到它们。

文档

首先，您需要创建一个 Client 实例

<?php

require __DIR__ . '/vendor/autoload.php';

use MetaLine\ActiveCampaign\Client;

$apiURL = 'https://<YOUR ACCOUNT>.api-us1.com';
$apiKEY = 'super-secret-key'; // Never publish this key!

$client = new Client($apiURL, $apiKEY);

现在您已经准备好与 ActiveCampaign API 进行通信了。例如，您可以检索所有联系人

$result = $client->get('contacts');

或者创建一个新的联系人

$result = $client->post('contacts', [
    'contact' => [
        'email'     => 'johndoe@example.com',
        'firstName' => 'John',
        'lastName'  => 'Doe',
        'phone'     => '7223224241',
    ]
]);

或者删除现有的一个

$result = $client->delete('contacts/' . $contactId);

等等。

有关其他 API 的详细信息，请参阅 ActiveCampaign 文档。

与 Result 对象一起工作

所有 Client 方法都返回一个 Result 对象，它是一个简单的值对象

if ($result->isSuccessful()) {
	$data = $result->getData();
} else {
	$errors = $result->getErrors();
}

调试结果以了解如何进行操作。

许可证

此项目根据 MIT 许可证授权。有关详细信息，请参阅 LICENSE 文件。

metaline / activecampaign-sdk

维护者

详细信息

README

安装

需求

文档

与 Result 对象一起工作

许可证