接口调用说明
# 接口调用说明
# 请求头
请求的header中请不要随意增加不在报文范例中的键值对，否则服务器端可能由于无法理解请求中包含的header，而返回400 Bad Request错误。
所有接口请求头部都需要放入Authorization属性，格式规范："Bearer " + accessToken，获取accessToken的接口除外。
accessToken访问令牌获取，详见：获取授权令牌。
部分接口请求头部需要指定contentType，具体参考接口的请求报文示例。
# 请求数据
- 接口根据设计的不同，请求数据的传参方式也不同，例如查询参数、路径参数、application/x-www-form-urlencoded、application/json等，具体需要参考接口的请求报文示例。
- 接口中的字段长度均表示最大长度，给第三方设计数据库字段长度做参考。
- 必传参数没有传、传参方式不对、参数格式不对等情况下接口会返回参数错误，请对照接口文档进行修改。
# 请求示例
接口示例：
POST /open/edu/basic/v1/device/add HTTP/1.1
Host: api.zkbiocloud.com
Content-Type:application/json
Authorization : Bearer 9A2C*******jL8zQ
1
2
3
4
2
3
4
请求包体：
{
"payload": {
"params": {
"sn": "3394172800218",
"name": "iface702",
"type": 0,
"unitId": "a4f***2343ads3",
"zoneId": "Asia/Shanghai",
"remark": "jack test device"
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
数据返回样例：
{
"code": "00000000",
"payload": {
"results": {
}
}
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 返回结果说明
请求返回的HTTP状态码为200表示请求成功，非200的错误码则为请求错误。
请求返回数据中的code为"00000000"时表示请求成功。
请求返回非"00000000"的code则需要对照错误码表进行判断，一般返回的msg中已有错误信息的说明。