README

非官方ConvertKit PHP API for v3。

此软件包简化了对ConvertKit网络API的访问。有关ConvertKit API的更多信息，请访问https://developers.convertkit.com。

安装

通过Composer

$ composer require firewards/convertkit-php-api

要求

以下版本的PHP得到支持。

• PHP 5.6
• PHP 7.0
• PHP 7.1
• PHP 7.2
• PHP 7.3

API密钥

所有API调用都需要API密钥。您可以在ConvertKit账户页面找到您的API密钥。

API密钥

一些API调用需要API密钥。所有需要API密钥的调用也将与API密钥一起工作，无需同时使用两个密钥。此密钥可以访问您的订阅者的敏感数据和操作。

用法

首先使用ConvertKit API并使用您的ConvertKit API密钥创建一个实例

$api = new \Firewards\Apis\ConvertKit($api_key, $api_secret);

示例

获取所有订阅者

使用分页获取所有订阅者。

$i = 0;
while ($subscribers = $api->getSubscribers($i++))
{
    if (!isset($subscribers->subscribers) || count($subscribers->subscribers) === 0)
    {
        break;
    }
    
    var_dump($subscribers);
}

获取所有自定义字段

$customFields = $api->getCustomFields();

创建自定义字段

$lastNameField = $api->createCustomField('last_name');

更新订阅者

更新订阅者并将信息添加到自定义字段 'last_name'。

$subscriberId = '1234';
$lastNameField = $api->updateSubscriber($subscriberId, ['last_name' => 'Stücken']);

获取标签

检索所有标签。

$tags = $api->getTags();

将订阅者添加到标签

将订阅者添加到特定标签。

$added = $api->addSubscriberToTag($tagId, $email);

订阅表单

将订阅者添加到表单。响应 $subscribed 将是一个对象。

$tag_id = '99999'; // This tag must be valid for your ConvertKit account.

$options = [
			'email'      => 'test@test.com',
			'name'       => 'Full Name',
			'first_name' => 'First Name',
			'tags'       => $tag_id,
			'fields'     => [
				'phone' => 134567891243,
				'shirt_size' => 'M',
				'website_url' => 'testurl.com'
			]
		];

$subscribed = $api->form_subscribe($this->test_form_id, $options);

获取订阅者ID

获取给定电子邮件地址的ConvertKit订阅者ID。

$subscriber_id = $api->get_subscriber_id( $email );

获取订阅者

获取ConvertKit订阅者的数据。

$subscriber = $api->get_subscriber( $subscriber_id );

获取订阅者标签

获取应用于订阅者的所有标签。

$subscriber_tags = $api->get_subscriber_tags( $subscriber_id );

将标签添加到订阅者

将标签应用于订阅者。

$tag_id = '99999'; // This tag must be valid for your ConvertKit account.
$api->add_tag(tag_id, [
			'email' => 'test@test.com'
		]);

速率限制

请注意，ConvertKit会对每分钟120个请求进行速率限制。如果您的请求速率超过限制，ConvertKit PHP Api将抛出RateLimitExcededException异常。

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。

赞助商

此软件包由www.firewards.com赞助，Firewards使您能够轻松地为您的电子邮件列表和时事通讯设置推荐和奖励计划。