README

简介

Loops PHP SDK 为与 Loops API 交互提供了一个表达式的接口。

需求

需要 PHP 8.1+

安装

您可以使用 Composer 包管理器将 Loops 安装到项目中

composer require plutolinks/loops

用法

您可以创建 SDK 实例，如下所示

use PlutoLinks\Loops\Loops;

$loops = Loops::client('<api-key>'); 

联系人

创建新的联系人

$response = $loops->contacts()->create([
    'email' => 'john@example.com',
    'firstName' => 'John',
]);

您可以访问响应的属性

$response->success;
$response->id;
$response->message;

API 参考

检索联系人

$contact = $loops->contacts()->retrieve('john@example.com');

您可以访问联系人的属性

$contact->email;
$contact->firstName;
$contact->id;
$contact->lastName;
$contact->source;
$contact->subscribed;
$contact->userGroup;
$contact->userId;

$contact->favoriteColor; // Custom property

API 参考

更新联系人

$response = $loops->contacts()->update('john@example.com', [
    'firstName' => 'John',
]);

您可以访问响应的属性

$response->success;
$response->id;
$response->message;

API 参考

删除联系人

$loops->contacts()->delete(email: 'john@example.com');

或者，您可以通过 userId 删除联系人

$loops->contacts()->delete(userId: 'asdf');

您可以访问响应的属性

$response->message;
$response->success;

API 参考

自定义字段

$fields = $loops->contacts()->customFields();

您可以访问响应的属性

foreach ($fields as $field) {
    $field->key;
    $field->label;
    $field->type;
}

API 参考

事件

发送事件

$response = $loops->events()->send(
    eventName: 'signup',
    email: 'john@example.com',
    properties: [
        'firstName' => 'John',
    ]
);

您可以访问响应的属性

$response->success;
$response->message;

API 参考

事务性电子邮件

发送事务性电子邮件

$response = $loops->transactional()->send(
    transactionalId: 'asdf',
    email: 'john@example.com',
    dataVariables: [
        'url' => 'https://example.com',
    ],
    attachments: [
        [
            'contentType' => 'application/pdf', 
            'data' => '/9j/4AAQSkZJRgABAQEASABIAAD/4...', 
            'filename' => 'file.pdf', 
        ],
    ]
);

您可以访问响应的属性

$response->success;
$response->error;
$response->message;
$response->path;
$response->transactionalId;

由于 Loops API 错误响应的差异，需要在不同位置检查错误。

API 参考

鸣谢

• Hosmel Quintana
• 所有贡献者

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 获取更多信息。