RestAPI概述
最新更新:2025-03-18
基本约束
- API 被设计为符合 HTTP、 REST 规范。例如:查询请求使用 Get 方法,提交请求使用 POST 方法。如果一个请求不是相应的 HTTP 方法,将返回错误。
- 如无特殊说明,调用参数值应转码为:UTF-8, URL 编码。
数据中心及Base URL
数据中心 | Base URL |
---|---|
新加坡 | https://ma-api.engagelab.com |
当使用 REST API 时,需要将选定的 base URL 与具体 API 的路径结合起来获得完整的调用地址。
{base URL}/{API路径}
{base URL}/{API路径}
此代码块在浮窗中显示
鉴权方式
EngageLab REST API 采用 HTTP 基本认证 的验证方式:HTTP Header(头)里加 Authorization:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
此代码块在浮窗中显示
上述 base64_auth_string 的生成算法为:base64(api_key:api_secret)
- Header 名称是 "Authorization",值是 base64 转换过的 "username:password" 对(中间有个冒号)。
- 在 MA API 的场景里,username 是 APIKey,password 是 APISecret。请在数据来源中添加 API 类型的数据源获得 APIKey 与 API Secret。