README

The official PHP client library for the Creamailer API.

要求

PHP 5.6或更高版本。

安装

您可以使用Composer安装Creamailer API

composer require creamailer/creamailer-api-sdk

安装后

如果您的应用程序没有自动加载器，请使用以下行添加它：require("vendor/autoload.php")

示例

要使用Creamailer API，您需要CREAMAILER_ACCESS_TOKEN和CREAMAILER_SHARED_SECRET。您可以通过登录Creamailer并在以下选项中选择来获取密钥： 用户名 > 设置 > API。

入门

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

use Creamailer\Creamailer;

$creamailer = new Creamailer(YOUR_CREAMAILER_ACCESS_TOKEN, YOUR_CREAMAILER_SHARED_SECRET);

测试连接

您可以使用以下ping方法测试连接。

$result = $creamailer->ping();

if ( ! $result->success) {
    echo 'Error: ' . $result->message;
}

print_r($result);

列表

创建列表

$listName = 'My list';
$listLanguage = 'fi';
$listAutoSuppress = true;

$result = $creamailer->lists()->create(
    $listName,
    $listLanguage,
    $listAutoSuppress
);

print_r($result);

获取列表

$listId = 1234;

$result = $creamailer->lists()->show(
    $listId
);

print_r($result);

获取所有列表

$result = $creamailer->lists()->showMany();

print_r($result);

获取列表订阅者

$listId = 1234;

$result = $creamailer->lists()->subscribers(
    $listId
);

print_r($result);

更新列表

$listId = 1234;
$listName = 'My list';
$listLanguage = 'fi';
$listAutoSuppress = true;

$result = $creamailer->lists()->update(
    $listId,
    $listName,
    $listLanguage,
    $listAutoSuppress
);

print_r($result);

删除列表

$listId = 1234;

$result = $creamailer->lists()->delete(
    $listId = 1234
);

print_r($result);

订阅者

创建订阅者

$listId = 1234;
$email = 'name@example.com';
$name = 'Firstname Lastname';
$company = 'Company Name';
$address = 'Street 1';
$city = 'Helsinki';
$zip_code = '00100';
$country = 'Finland';
$phone = '040123456';
$customer_number = '1234';
$send_autoresponders = true;
$send_autoresponders_if_exists = true;
$status = 'active';

// If list has custom fields
$some_custom_field = 'some extra info';

$result = $creamailer->subscribers()->create(
    $listId,
    [
        'email' => $email,
        'name' => $name,
        'company' => $company,
        'address' => $address,
        'company' => $company,
        'city' => $city,
        'zip_code' => $zip_code,
        'country' => $country,
        'phone' => $phone,
        'customer_number' => $customer_number,
        'send_autoresponders' => $send_autoresponders,
        'send_autoresponders_if_exists' => $send_autoresponders_if_exists,
        'status' => $status,
        'custom_fields' => [
            'some_custom_field' => $some_custom_field
        ]
    ]
);

print_r($result);

注意：仅在列表中存在自定义字段时才使用自定义字段。

获取订阅者

$listId = 1234;

$result = $creamailer->lists()->delete(
    $listId = 1234
);

print_r($result);

更新订阅者

$listId = 1234;
$email = 'name@example.com';
$name = 'Firstname Lastname';
$status' => 'active',

$result = $creamailer->subscribers()->update(
    $listId,
    [
        'email' => $email,
        'name' => $name,
        'status' => status
    ]
);

print_r($result);

删除订阅者

$listId = 1234;
$email = 'name@example.com';

$result = $creamailer->subscribers()->delete(
    $listId,
    $email
);

print_r($result);

屏蔽

创建屏蔽

将电子邮件添加到屏蔽列表。

$email = 'name@example.com';
 
$result = $creamailer->suppressions()->create(
    $email
);

print_r($result);

获取所有屏蔽

$result = $creamailer->suppressions()->show();
 
print_r($result);

删除屏蔽

从屏蔽列表中删除电子邮件。

$email = 'name@example.com';
 
$deleteResult = $creamailer->suppressions()->delete(
    $email
);

print_r($result);

支持和反馈

如果您发现任何错误，请直接在此GitHub中提交问题。

对于未来的改进请求，也请提出问题，以便我们可以进一步讨论。

我们使用PHPUnit单元测试库，但由于它是API，我们不发布测试。我们不推荐任何人针对我们的公共API地址运行测试。

creamailer / creamailer-api-sdk

维护者

详细信息