平台简介
新手指南
API协议
API文档
单点登录集成
小程序插件
常见问题
开放平台API接口调用常见报错以及解决方法汇总
帮助中心 / 开放平台帮助文档 / API协议
API协议
API协议

API协议

契约锁开放平台API基于HTTPS协议,您可以使用我们提供的SDK直接调用,也可以自行封装请求进行调用,以下对自行封装请求进行说明。

调用地址

测试环境:https://openapi.qiyuesuo.cn

正式环境:https://openapi.qiyuesuo.com

调用流程

生成签名 > 封装请求 > 发起请求 > 得到响应

生成签名

所有开放平台的API接口,header中必须添加下面四个参数,用以校验身份。

(1)x-qys-open-accesstoken: 用来确认对接方身份,是申请开放平台后获取的 AppToken。

(2)x-qys-open-timestamp: 时间戳,Unix TimeStamp,单位为毫秒;

(3)x-qys-open-nonce: 请求的唯一标识,一般用UUID来标识。10分钟内只能被使用一次,用于防止重放攻击。

(4)x-qys-open-signature: 签名数据,用来校验请求是否有效。生成方式:Md5(AppToken + AppSecret + timestamp + nonce),即AppToken 和 AppSecret 和 时间戳 和 nonce 拼接的字符串的MD5值。

API调用示例如下:

GET /v2/seal/list?selectOffset=0&selectLimit=2 HTTP/1.1
Host: openapi.qiyuesuo.cn
x-qys-open-timestamp: 1565753984643
x-qys-open-signature: 4e77af6b465c4080e25ecd012eaf2916
x-qys-open-accesstoken: DWjfxmA12a
x-qys-open-nonce: 254775d7-3c7c-4e9d-9880-1d4c5fb3dbd0

发起请求

请求的URL需要URL编码,详情参考API文档。

得到响应

API的响应包的Body部分采用JSON格式编码,因此需要对返回包进行JSON解析。