说明
获取项目中指定设备的访问链接
请求地址
https://openapi.haiwell.com/api/v1/devices/visit
请求方法
POST
公共请求参数
参数名称 | 参数类型 | 数据类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
Client-ID | Header | String | 是 | 开发者中心应用密钥 clientID |
Authorization | Header | String | 是 | 通过 Credentials 获取的 token |
请求参数
参数 | 参数类型 | 数据类型 | 是否必需 | 描述 |
---|---|---|---|---|
device_code | body | String | 是 | 设备 PN 码 |
is_read | body | Long | 是 | 只读权限 0 关闭,1 开启 |
HTTP 状态码
返回值 | 描述 |
---|---|
200 | 操作成功,详见响应参数 |
429 | 并发限流 |
500 | 服务端异常 |
业务错误码
返回值 | 描述 |
---|---|
10000 | 客户端传参异常,详见异常响应参数 |
10001 | 公共参数错误 |
10016 | client 下线或者 clientId 不正确(身份不正确) |
10019 | token 已过期 |
50000 | 服务端异常 |
响应参数
参数 | 参数类型 | 描述 |
---|---|---|
code | String | 成功返回码默认 0 |
reason | String | 服务端定义的标签,用于业务快速定位问题 |
data | Object | 返回数据结构体 |
- data.visit_url | Long | 工程访问链接 |
异常响应参数
参数 | 数据类型 | 描述 |
---|---|---|
error_msg | String | 表示一个错误代码字符串,可以用于对错误进行分类,并对错误进行处理 |
code | Long | 服务端定义的错误码,用于快速定位问题 |
reason | String | 服务端定义的标签,用于业务快速定位问题 |
请求消息示例
GET /webscadas/10487 HTTP/1.1
Host: openapi.haweill.com
Content-Type: application/json
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"code": 0,
"data": {
"visit_url": "772383232323231.iotbus.cn.com"
}
}