REST API 概述

基本约束

• API 被设计为符合 HTTP、 REST 规范。例如：查询请求使用 GET 方法，提交请求使用 POST 方法。如果一个请求不是相应的 HTTP 方法，将返回错误。
• 如无特殊说明，调用参数值应转码为：UTF-8， URL 编码。

数据中心及Base URL

当使用 REST API 时，需要将选定的 base URL 与具体 API 的路径结合起来获得完整的调用地址。

              
              {base URL}/{API路径}

            

鉴权方式

EngageLab REST API 采用 HTTP 基本认证 的验证方式：HTTP Header（头）里加 Authorization：

              
              Authorization: Basic ${base64_auth_string}

            

上述 base64_auth_string 的生成算法为：base64(api_key:api_secret)

• Header 名称是 "Authorization"，值是 base64 转换过的 "username:password" 对（中间有个冒号）。
• 在 LiveDesk API 的场景里，username 是 API Key，password 是 API Secret。请在「项目设置-API管理」中添加 API 类型的数据源获得 API Key 与 API Secret。