2.2基本规则
(1)数据格式
基础营销平台 API使用 JSON作为消息体的数据交换格式。请求须设置 HTTP 头部:
Content-Type: application/json
Accept: application/json
文件上传 API 除外。
(2)字符集
基础营销平台 API使用且仅支持 UTF-8 字符集,请求可以在 content-type 中显示指定使用 UTF-8,未指定则默认 UTF-8 编码。
(3)传输协议
所有的 API 请求必须使用 HTTPS,不应忽略服务器证书验证的错误,避免被恶意劫持。
(4)身份验证
基础营销平台 API通过数字签名方式对调用方进行身份验证。请求发起阶段,开发者需要使用对接私钥对请求内容进行签名,基础营销平台会使用对接公钥验证请求签名,以确保请求由开发者发出;同样的,在响应阶段,基础营销平台会使用基础营销平台私钥对响应结果进行签名,开发者需要使用基础营销平台公钥验证签名,以确保响应由基础营销平台发出。
身份信息需要通过请求的请求头 Authorization 字段传递,对应值可以参考 签名规则。
对接私钥代表应用身份,请确保私钥的安全,不要在 GitHub、客户端代码等公共可访问区域共享对接私钥。
(5)请求的唯一标志
基础营销平台返回响应时,会对请求分配唯一请求标识,请求的唯一标识包含在响应的 HTTP 头 基础营销平台-trace-id 中,包含 a-zA-Z0-9-_ 字符。
当需排查问题时,可以向技术支持提供请求的唯一标识,以便我们更快的定位到具体的请求。