Skip to main content
Sendify 提供一套 RESTful API,目前已开放联系人管理能力。创建 API Key 后,可以先调用 /v2/me 验证密钥和账号信息,再接入联系人接口。 当前文档版本:1.0.0-beta
如果你希望让 Codex、Cursor 或 Claude 通过自然语言查询 Sendify 数据,请参阅 Sendify MCP。MCP 当前为只读能力,适合查询营销活动、投递表现和联系人。

基础地址

所有 API 请求均应通过 HTTPS 发起,并在 Authorization 请求头中携带 Bearer API Key。

1. 获取 API Key

打开 Sendify 控制台的「开放能力」,进入「API 密钥」页面,然后点击「创建密钥」。
API Key 的完整内容只展示一次。创建后请立即将其保存到安全的密钥管理系统。
控制台路径:

2. 验证 API Key

发送以下请求,确认 API Key 和账号信息有效:
返回 HTTP 200 且响应中包含账号信息,说明 API Key 有效,可以继续调用联系人接口。
不要在浏览器前端代码、公开仓库、日志或面向终端用户的环境中存储 API Key。生产集成应由后端服务发起请求。

3. 创建联系人

联系人接口接受 JSON 请求体。下面是一个最小请求示例:
如需添加标签、自定义字段或设置联系人冲突策略,请参阅左侧导航中的「创建联系人」接口文档。

4. 处理错误与限流

批量同步联系人时,建议使用队列削峰,并设置最大重试次数。记录接口路径、HTTP 状态码和业务对象 ID,便于排查问题。

5. API Key 安全建议

  • 为开发、预发和生产环境分别创建独立的 API Key。
  • 按最小权限原则配置每个 API Key。
  • 在人员变更或疑似泄露时立即禁用旧 API Key。
  • 不要将生产 API Key 用于本地调试或共享测试。