登录鉴权
(1)HTTP(S)协议登录鉴权接口原型
请求方法 | POST |
请求地址 | http:// *.non-nb.ctwing.cn:8991/auth |
传输协议 | HTTP(S) |
(2)HTTP(S)协议登录鉴权请求头部
参数 | 必选/可选 | 类型 | 位置 | 描述 | |
signKey | 必选 | String | Header | 签名秘钥,设备生成(自定义),携带至平台 | |
timestamp | 必选 | Int | Header | 时间戳(自己生成)。(20分钟有效,前后时间差不超过10分钟) | |
signature | 必选 | String | Header | 签名。 算法:sha256(signKey+MasterKey+timestamp) MasterKey为平台上创建产品时自动生成,可在产品概况中查询。 | |
Content-Type | 必选 | String | Header | application/json |
(3)HTTP(S)协议登录鉴权请求参数
参数 | 必选/可选 | 类型 | 位置 | 描述 |
productId | 必选 | Int | Body | 产品Id,平台产品信息中获取 |
deviceId | 必选 | String | Body | 设备Id,平台设备信息管理中获取。 |
password | 必选 | String | Body | 设备特征串。平台生成,每个设备唯一 |
version | 可选 | String | Body | 版本号。 |
(4)HTTP(S)协议登录鉴权响应参数
参数 | 描述 |
code | 业务返回码,0为成功 |
message | 鉴权结果 |
accessToken | 鉴权参数,访问天翼物联网平台(AIoT)的凭证。每次上报数据时,都需要携带accessToken信息。如果accessToken失效,需要重新认证获取accessToken。accessToken的有限期为5分钟。 |
(5)请求示例
Method: POST
request:http:// *.non-nb.ctwing.cn:8991/auth
timestamp: 1604567280000
signKey: test
signature: b515b5ff3b67eb6f3b4c4a59d4baabee00902f34aeeba0c53c5a20382a4b9951
Content-Type: application/json
Body:
{
“productid”: 1000***1,
“deviceId”: “1000***11234”,
“password”:” 2uUCYgSB_wyvcgWwqMYyZ3wM2sbkTdTuoVXNTYJ2vss”,
“version”:“1.0”
}
signature 生成方式:
signKey =test
masterKey=a4af6820303b4770af294d7147777997
timestamp=1604567280000
signature=sha256(signKey+MasterKey+timestamp)=sha256(testa4af6820303b4770af294d71477779971604567280000)=b515b5ff3b67eb6f3b4c4a59d4baabee00902f34aeeba0c53c5a20382a4b9951
(6)响应示例
response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
“code”: 0,
“message”: “SUCCESSFUL”,
“accessToken”: “*******”
}
(7)HTTP(S)协议登录鉴权HTTP状态码
HTTP状态码(Status Code) | 描述 | 说明 |
200 | OK | 请求正常 |
400 | Bad request | 请求数据缺失或格式错误 |
401 | Unauthorized | 请求缺少权限 |
403 | Forbidden | 请求禁止 |
404 | Not found | 请求资源不存在 |
500 | Internal Error | 服务器异常 |
503 | Service Unavailable | 服务不可用 |
504 | Async Service | 异步通讯 |
(8)HTTP(S)协议登录鉴权业务返回码
业务返回码 | 描述 | 说明 |
0 | SUCCESSFUL | 登录成功 |
10000 | common error | 未知错误 |
10001 | Product is not exist. | 产品不存在。不存在此productId对应的产品。 |
10002 | Device is not exist. | 设备不存在。不存在此deviceId对应的设备。设备未注册、已删除或已注销。 |
10003 | Parameter error | 参数验证失败。缺少参数或参数格式错误 |
20000 | signature error | 签名错误 |
20001 | Auth Failure | 设备鉴权失败 |