API 对接指南
本页面面向需要开发或检查连接内容所调用 API 的开发团队。请将 API 地址、请求方式、认证方式和响应示例（JSON）提供给营销人员。
API 要求
Section titled “API 要求”| 区分 | 要求 |
|---|---|
| 协议 · 端口 | 只调用 http 或 https，以及标准端口（80、443） |
| 私有网络 | 无法调用内网或内部 IP。地址必须可以从外部访问 |
| 地址 | 变量替换后不超过 2048 个字符。不能以 user:pass@ 的形式包含认证信息（请使用认证信息登记） |
| 重定向 | 不跟随 3xx 重定向。请指定最终地址 |
| 成功判定 | 只有 2xx 视为成功。4xx · 5xx 即使有响应正文也按失败处理 |
| 响应时间 · 大小 | 2 秒以内，1MB 以下 |
| 响应格式 | 建议使用 JSON 对象，也可以使用纯文本 |
| JSON 响应头 | · 要作为 JSON 使用，必须带上 Content-Type: application/json· 没有该响应头或为 text/plain 时，即使正文是 JSON 也按文本处理· 声明为 JSON 但正文不是 JSON 时，按失败处理 |
发出 IP 与请求头
Section titled “发出 IP 与请求头”FlareLane 从固定 IP 发起调用。如果您通过防火墙限制访问，请向负责的客户经理获取发出 IP 并加入允许列表。所有调用都会带上以下请求头。
| 请求头 | 值 |
|---|---|
User-Agent | FlareLane-ConnectedContent/1.0 |
X-flarelane-connected-content-request-id | 每个请求不同的唯一 ID |
X-flarelane-connected-content-request-timestamp | 请求时间（ISO 8601） |
调用量与重复请求
Section titled “调用量与重复请求”- 调用次数与收件人数并不相同。每个指令都会调用一次，重新处理时可能再次调用，也可能因缓存而减少。
- 用于大批量发送的 API，需要能承受比收件人数更多的请求。反复返回 429 会触发熔断。
- 像发放优惠券这样每次调用都会产生结果的 API，请确保同一请求再次到来时结果不会重复。例如：直接返回已经发放的优惠券。
通过服务器日志查找原因
Section titled “通过服务器日志查找原因”调用失败时，消息中只会留下空白。请在服务器日志中查看 FlareLane 请求（通过 User-Agent 和请求 ID 请求头区分）的响应码。
| 响应码 | 需要确认 |
|---|---|
| 400 | body 格式是否符合 API 预期的格式。如果是 JSON，是否遵循了推荐写法 |
| 401 | 认证信息的值（ID · PW · 请求头值）是否正确 |
| 403 | 是否已允许发出 IP，是否拦截了 User-Agent，令牌是否具有该 API 的权限 |
| 404 | 地址和路径中填入的变量值是否正确 |
| 405 | :method 是否与 API 接受的方式一致 |
| 429 | 是否超出了处理上限。反复出现会触发熔断 |
| 5xx | 服务器错误。反复出现 502 · 503 · 504 会触发熔断 |