数据来源与API

如何使用 Sendtric API 将记录发送至数据来源

最后更新

使用 API 数据来源时,每当您的数据发生变化,您的系统就会向 Sendtric 发送 JSON 记录。Sendtric 会将这些记录存储为托管数据,当电子邮件被打开时,您的图片会查询每位订阅者的记录。

本指南适用于负责编写数据发送代码的开发者。如果您希望 Sendtric 在每次打开时从您的 API 获取数据,请参阅如何将数据来源连接到您自己的 API.

创建数据源

  1. 在左侧边栏中,点击数据来源,然后新建数据来源.
  2. Under API下,选择API,然后点击继续.
  3. 选择将数据发送至 Sendtric,然后点击继续.
  4. 请填写:
    • 数据源名称:例如“忠诚会员”。
    • 唯一标识符字段:用于标识每条记录的 JSON 字段,例如customer_id或email。您发送的每条记录都必须包含该字段。
    • 描述(可选)。
  5. 点击保存数据来源。数据来源已创建,且API步骤中将显示您的端点和 API 密钥。
  6. 复制所需内容,然后点击继续以完成操作。
新数据来源的 API 步骤,其中显示了单条记录和批量插入/更新(upsert)端点、API 密钥以及示例请求

您可以随时在数据来源的API 详细信息选项卡中再次找到这些端点。

验证

请在Authorization每个请求的请求头中:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

该数据来源 API 密钥仅用于发送数据来源记录,因此将其提供给开发人员或自动化工具是安全的。如果您使用的是 API 套餐,您现有的 API 套餐密钥在这些端点上同样有效。

请勿在前端代码和公共代码库中暴露密钥。如果密钥不幸泄露,请在设置→ API 密钥→数据来源 API 密钥下重新生成,然后更新所有使用该密钥的代码。

创建或更新记录

将单个 JSON 对象或对象数组 POST 到 Sendtric 中显示的端点。单条记录:

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "customer_id": "CUST_1001",
  "first_name": "Sarah",
  "points": 1250
}

一个请求中包含多个记录:

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

[
  { "customer_id": "CUST_1001", "first_name": "Sarah", "points": 1250 },
  { "customer_id": "CUST_1002", "first_name": "James", "points": 300 }
]

记录的保存方式:

  • 如果尚无记录具有该标识符,则会创建一条新记录。
  • 如果有人这样做,那会被替换为发送的内容。未填写的字段将被删除,因此请务必发送完整的记录。
  • 新记录和更新后的记录通常在约一分钟内即可查阅。
  • 标识符的匹配不区分大小写。

请求成功时返回200并附带简短摘要,例如{"status":"ok","records":2}.

您可以在记录中嵌套对象,例如"address": { "city": "Leeds" },并在图像编辑器中选择嵌套字段。

删除记录

通过在端点末尾添加该记录的标识符来删除一条记录:

DELETE <your data source endpoint>/cust_1001
Authorization: Bearer YOUR_API_KEY

通过发送一个标识符数组来删除多个:

DELETE <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

["cust_1001", "cust_1002"]

极限

上限值
每次请求的记录数10,000
请求大小10 MB
标识符值255个字符
任意单个文本值10 KB
嵌套深度20个关卡

请分批发送记录,而不是每条记录都单独发送一个请求。对于数千条记录,请参阅如何向数据来源发送大量数据.

响应和错误

状态其含义该怎么办
200已接受的记录没有。如果跳过了某些记录,X-Skipped-Records 标头会说明跳过了多少条
400正文不是有效的 JSON检查请求正文
401API密钥缺失或错误检查 Authorization 头
404未找到此键对应的数据来源检查端点,并确认该密钥属于同一账户
413记录过多或过大将请求拆分为较小的批次
422无法保存记录该消息列出了哪些记录缺少标识符字段或大小过大
503Sendtric 正在忙等待“Retry-After”标头中指定的秒数,然后再次发送相同的请求

当请求中只有部分记录无效时,有效的记录仍会被保存,其余的则会被跳过。

请核对您的记录

打开数据来源,然后转到记录选项卡。根据标识符值进行搜索,并点击某条记录以查看 Sendtric 存储的完整 JSON 数据。

下一步

这篇文章对你有帮助吗?

点击图片即可放大,拖动或滚动可查看其他区域。