enhavo/cleverreach

CleverReach REST API v3 客户端

v0.14.3 2024-06-11 07:28 UTC

README

alt text

CleverReach REST API v3 客户端

这个库使得与 CleverReach REST API v3 交互变得简单。

安装

composer require enhavo/cleverreach

使用方法

初始化 API 管理器

use Enhavo\Component\CleverReach\ApiManager;
use Enhavo\Component\CleverReach\Http\SymfonyAdapter;

$adapter = new SymfonyAdapter();

// Authorize your app by credentials
$adapter->authorize('<CLIENT_ID>', '<CLIENT_SECRET>');

// Create the API manager
$apiManager = new ApiManager($adapter);

创建一个非活跃订阅者

$response = $apiManager->createSubscriber(
    '<EMAIL>',
    '<GROUP_ID>',
    false, // not activated
    [
        'salutation' => 'Mr.',
        'firstname' => 'John',
        'lastname' => 'Doe',
    ]
);

if (isset($response['id'])) {
    // ...
}

为非活跃订阅者触发双确认邮件

$response = $apiManager->triggerDoubleOptInEmail('<EMAIL>', '<FORM_ID>');

if (isset($response['success'])) {
    // ...
}

为活跃订阅者触发双退出邮件

$response = $apiManager->triggerDoubleOptOutEmail('<EMAIL>', '<FORM_ID>');

if (isset($response['success'])) {
    // ...
}

获取订阅者

$response = $apiManager->getSubscriber('<EMAIL>', '<GROUP_ID>');

if (isset($response['id'])) {
    // ...
}

设置订阅者的活跃状态

$response = $apiManager->getSubscriber('<EMAIL>', '<GROUP_ID>', '<TRUE_OR_FALSE>');

if (true === $response) {
    // ...
}

删除订阅者

$response = $apiManager->deleteSubscriber('<EMAIL>', '<GROUP_ID>');

if (true === $response) {
    // ...
}