API 文档API 文档
资源中心
帮助中心
资源中心
帮助中心
  • 从这里开始

    • 快速入门
    • 关键概念
    • API 速率限制
    • 平台配额
    • 身份认证
  • 事务类邮件

    • 如何发送事务类邮件
    • 沙盒模式发送邮件
    • 发送事务邮件
    • 批量发送个性化事务邮件
    • 按计划发送事务邮件
    • 事务邮件跟踪
    • 获取事务邮件报告
  • SMTP 集成
  • 营销类邮件

    • 如何发送营销类邮件
    • 邮件营销活动列表
    • 模板管理
    • 获取营销活动报告
    • 联系人管理
    • 联系组管理
  • 发送方管理
  • Webhook

    • 推送数据
    • 配置管理

关键概念

更新时间:2025-01-15 10:29

以下是您在开始使用API之前需要了解的所有内容。

API服务接入点

api.effilink.co

请求参数

Web API的请求必须通过HTTPS发送,数据格式为 JSON (application/json),每次请求都应包含鉴权所需的头部字段:content-type: application/json 、ApiKey 、Authorization、Timestamp。

请求数据的默认字符集为UTF-8。

参数名是区分大小写的。

ApiKey可以在平台的设置中添加、管理。

分页

检索、查询类的接口,返回的结果可能会被分页,您可以使用以下参数来指定页码与每页记录数。

名称类型描述
pageSize整数每页返回的记录数
pageIndex整数返回第几页的数据,从1开始

返回参数

返回的响应信息都是JSON对象,不同接口返回的JSON对象是不同的。

错误对象包含错误代码和对应的描述信息。

API HTTP响应代码

下面是接口可以返回的HTTP相应代码:

HTTP code状态描述
200OK成功的请求
400Bad Request请求的数据格式不合法
404Not Found接口不存在
405Method Not Allowed不允许的请求方式,允许的方式有:GET、POST
429Too Many Requests请求频率超限
Prev
快速入门
Next
API 速率限制