janiskelemen / convertkitapi
此包的最新版本(dev-master)没有可用的许可证信息。
ConvertKit API SDK
dev-master
2021-02-02 09:36 UTC
Requires
- php: >=5.5
- guzzlehttp/guzzle: ^7.0
- monolog/monolog: ^2.0
Requires (Dev)
- phpunit/phpunit: ^6.0
This package is not auto-updated.
Last update: 2024-09-26 01:10:16 UTC
README
ConvertKit的官方PHP SDK
安装
标准安装
- 下载或克隆此仓库
- 运行
composer install
- 将
./vendor/autoload.php
添加到您的项目中
使用包管理器安装
如果您的项目使用 Composer,您可以将ConvertKitSDK-PHP包作为composer包安装。这样,您可以在这个项目作为依赖项的情况下,不需要将ConvertKitSDK-PHP文件提交到您的源代码中。
composer require convertkit/convertkitapi:dev-master
请注意,由于ConvertKitSDK-PHP尚未版本化,每次您运行 composer install
时,您的项目将始终从master分支下载最新文件,这可能导致未来出现破坏性更改。
使用方法
在 此处 获取您的ConvertKit API密钥和API密钥,并在您的应用程序中设置它们。
$api = new \ConvertKit_API\ConvertKit_API($api_key, $api_secret);
示例
订阅表单
向表单添加订阅者。响应中的 $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' ]);