API
>
接口概述
接口概述
更新时间:2021/07/06 10:34
说明
本文档是连犀云平台提供给企业客户的接口规范文档。接口基于 HTTP 协议,为企业提供易实现接入的交互接口。连犀云平台为每一个企业客户分配 api_key 以及
api_secret,api_key用于标识企业实体身份,api_secret
用于计算签名 sign。接口权限校验详见 2.1 校验机制。 接口中所有参数都以 JSON 形式封装传递。
请求数据格式说明
请求使用JSON报文格式。
Header中需要携带的公共参数如下
| 字段名称 |
字段类型 |
约束限制 |
说明 |
| Content-Type |
string(32) |
必选 |
application/json;charset=UTF-8 |
| api-key |
string(32) |
必选 |
企业id,用于调用者声明身份 |
| sign |
string(64) |
必选 |
参数签名,用于安全校验参数完整性和调用者的合法性,防止中间人篡改参数和未授权调用 |
Body中需要携带的公共参数如下
| 字段名称 |
字段类型 |
约束限制 |
说明 |
| ts |
int |
必选 |
unix时间戳,精度:秒。用于校验接口调用的时效性,防止重放攻击 |