接口调用说明
接口调用说明
请求协议
请求返回
1.
2.
请求限制
文档格式约定
1. 请求方式:GET/POST
2. 请求地址:https://api2.hik-cloud.com/api/v1/open/basic/groups/create
3. 请求包体:
4. ...
5. 参数说明:
6. ...
7. 返回结果:
8. ...
9. 参数说明
10. ...
·请求地址:接口的请求地址。云眸开放平台服务端接口的访问域名为https://api2.hik-cloud.com。
·请求包体/参数说明:提供请求参数示例及说明,参数说明包括字段名称、类型、描述等。
·返回结果/参数说明:提供返回参数示例及说明。
注意:
1. 所有接口(获取access_token接口除外)在调用时都会返回code、message和data,其中code=200时说明该接口调用成功,而code非200时则说明该接口业务调用异常,开发者可根据code和message排查问题。
2. 请不要仅根据message判断调用是否成功。当请求返回结果中返回了code且不为200时可判断为请求失败。message是对code的说明,供开发者参考排查问题。
接口调用流程
1.
2.
3.
所有服务端接口(获取access_token接口除外)请求时都需要将access_token放入Request Headers中Authorization属性中, 并在access_token前面加上Bearer且空格隔开,示图如下: