OTA API init - nxtele/http-api-document GitHub Wiki
一键登录
通过API获取授权登录的URL服务
- URL:
https://api2.nxcloud.com/api/ota/init
- Method:
POST
- Content-Type:
application/json
- 需要鉴权:
是
鉴权机制
鉴权规则请参考地址:API接口调用约定
请求参数
header参数:
| 参数名 |
类型 |
必选 |
示例值 |
说明 |
| accessKey |
String |
是 |
fme2na3kdi3ki |
用户身份标识 |
| ts |
String |
是 |
1655710885431 |
当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒 |
| bizType |
String |
是 |
6 |
OTA业务类型,取固定值“6” |
| action |
String |
是 |
init |
OTA业务操作,取固定值“init” |
| sign |
String |
是 |
6e9506557d1f289501d333ee2c365826 |
API入参参数签名,签名算法 |
body参数:
| 参数名 |
类型 |
必选 |
示例值 |
说明 |
| appkey |
String |
是 |
pem28kje |
应用appkey |
| phone |
String |
是 |
86158xxxx1795 |
手机号码 |
| userIp |
String |
是 |
xxx.xxx.xxx.xxx |
移动端的IP地址 |
请求示例
body(application/json) 参数:
{
"appkey": "pem28kje",
"phone": "86158xxxx1795",
"userIp": "xxx.xxx.xxx.xxx"
}
响应参数
| 参数名 |
类型 |
说明 |
| code |
Integer |
结果编码 |
| data |
JsonObject |
请求结果 |
| msg |
String |
请求结果说明 |
请求成功
| 参数名 |
类型 |
说明 |
| requestId |
String |
请求ID |
| url |
String |
身份验证链接 |
响应示例
成功示例
{
"code": 0,
"msg": "请求成功",
"data": {
"requestId": "989d535f78338411f7de07c028ddee4b",
"url": "https://api.xxxxx.com/auth?response_type=code&client_id=xxx"
}
}
失败示例
{
"code": 88,
"msg": "请求失败",
"data": null
}
响应码说明
| code |
message |
解决办法 |
| 0 |
Request successful |
|
| 99 |
System error |
请联系技术人员排除问题 |
| 1000~100X |
鉴权问题 |
详情查看API鉴权部分 |
| 9901 |
Parameter error or empty |
参数遗漏,请检查必须的参数 |
| 9906 |
App does not exist or is unavailable |
核查下应用是否创建/禁用问题 |
| 9907 |
App does not have corresponding country pricing |
联系业务人员处理报价问题 |
| 9908 |
Insufficient account balance |
确认余额 |
| 2204 |
Request failed |
请联系技术人员排除问题 |
| 2206 |
Exceeded rate limit |
请求过于频繁,请稍后再试 |