README

AVADA 邮件营销 API PHP 绑定，使开发者更容易连接到 AVADA 营销自动化平台。

目录

• 安装
• API
• 示例
• 支持

安装

composer require avadaio/avadaio-php-client

API

我们的 API 文档位于： AVADA API 文档。您可以在我们的 API 中看到更多参考。

初始化实例

AvadaIoSdk 使用 curl 扩展来处理 HTTP 请求。因此，您需要安装并启用 PHP 的 curl 扩展。

$avadaio = new AvadaIo\AvadaIoSdk([
    'appId' => "[YOUR_APP_ID]", 
    "appKey" => "[YOUR_APP_KEY]"
]);

此模块导出一个构造函数，该函数接收一个关联数组。

AvadaIoSdk(options)

创建一个新的 AVADA 实例。

参数

• options - 必需 - 一个具有两个索引的关联数组

选项

• appId - 必需
• appKey - 必需

您可以在创建 AVADA 账户后，转到“管理密钥”页面以获取您的 appId 和 appKey。

返回值

一个 AvadaIoSdk 实例。

异常

如果缺少必需的选项，则抛出 SdkException 异常。

资源

每个资源都是通过您的 $avadaio 实例访问的

$avadaio = new AvadaIo\AvadaIoSdk([
    'appId' => "[YOUR_APP_ID]",
    "appKey" => "[YOUR_APP_KEY]"
]);

// $avadaio-><resource_name>-><method_name>

每个方法返回一个具有 3 个属性的 ApiResponse 对象

• success - 布尔值
• data - 任何 - 可选
• message - 字符串

$result = $avadaio->Contact->create([
    "description" => "",
    "email" => "john@doe.io",
    "firstName" => "John",
    "isSubscriber" => true,
    "lastName" => "Doe",
    "phoneNumber" => "+123465789",
    "phoneNumberCountry" => "US",
    "source" => "magento",
    "orderCount" => 0,
    "totalSpent" => 0,
    "country" => "US",
    "city" => "",
    "address" => "",
    "tags" => "Email Marketing"
]);

API 返回的 JSON 如此

{"success": true, "message": "Hook create/update customers complete"}

所有资源的此行为相同。

示例

测试连接

 $result = $avadaio->Connection->test();
if ($result->success) {
  echo 'Connection established';
}

更多示例可以在项目源代码中的 tests 文件夹中找到。

可用资源和方法

• 连接
  • test() 使用您的 appKey 和 appId 测试连接
• 表单
  • list() 获取要集成到页面构建器中的 AVADA 表单列表
• 联系
  • create(data) 在 AVADA 管理员中创建一个新的联系人
  • update(data) 在 AVADA 管理员中更新现有的联系人
  • bulk(data) 在 AVADA 管理员中以批量方式创建新联系人
• 订阅者
  • add(data) 将新联系人添加到您的联系人列表作为订阅者。触发新订阅者自动化事件。
• 评论
  • submit(data) 触发在您的商店提交新评论。触发新评论自动化事件。
• 结账
  • create(data) 触发一个新结账事件到 AVADA，该事件将用于弃购车自动化。
  • update(data) 触发 AVADA 中结账事件的更新。例如，更新结账电子邮件，以便购物车有资格获得弃购车电子邮件。
  • remove(id) 删除结账。
• 订单
  • create(data) 触发一个新订单事件到 AVADA。触发新订单自动化事件。
  • update(data) 更新现有订单。
  • complete(data) 完成订单。触发交叉销售、升级自动化事件。
  • bulk(data) 使用批量订单插入同步您的订单到 AVADA。
  • refund(data) 触发退款事件到 AVADA
  • invoice(data) 触发履行事件到 AVADA
  • ship(data) 触发运输事件到 AVADA

支持

如果您需要任何支持，您可以通过应用程序内的客户聊天支持联系我们