希沃物联平台文档

请求通用说明

1 基本说明

  • 基本地址: 参考环境说明，正式环境为https://iot.seewo.com/iot-platform-service

  • 具体接口描述只展示uri，请求时拼接基本地址。

  • body入参均为json，需要在请求header中添加：Content-Type:application/json;charset=UTF-8

【注】设备动态注册接口不参与此规则。

2 公共请求header

调用每个API时都需要使用的请求header。

名称 是否必需 描述
x-auth-accesskey 是 应用授权码，需在IoT管理平台创建。
x-auth-traceid 是 唯一请求ID，5分钟不能重复。
x-auth-ts 是 请求时间戳，用于判断签名的时效性，13位。
x-auth-sign 是 签名结果，生成方式参考签名机制。

超时排错提示

其中x-auth-ts是调用方当前时间戳，只有当调用方和服务器时间相差较大，才应该查阅接口获取服务器时间戳。

3 公共返回参数

API返回结果采用统一json格式，返回000000 代表一次请求调用成功；返回其他6位状态码代表调用失败。

返回字段说明：

名称 类型 描述
code String 6位数字字符串表示的业务状态码，默认000000，表示成功。异常时可根据code查找相应的异常信息。
message String 异常提示信息，当code不是000000时，此字段有提示信息。默认success。
data T 具体的请求业务结果，可能为null。

公共错误码：

code message
120100 参数校验不通过
120116 数据不存在或权限不匹配
120200 数据库操作异常
120300 调用关联系统失败
999999 未知异常

示例：

// 成功示例
{
    "code": "000000",
    "data": {
        "content": [
            {
                "id": "297160167601094656",
                "latelyOnlineTime": 1562835034000,
                "name": "SK-1",
                "nodeType": "DEVICE",
                "productKey": "1_783dcb3cf4d",
                "productName": "zunrong的直连设备产品",
                "status": "FORBIDDEN",
                "subNum": 0
            }
        ],
        "page": 1,
        "size": 10,
        "total": 1
    },
    "message": "success"
}

// 异常示例
{
    "code": "120300",
    "data": null,
    "message": "IoT api调用出现未知异常"
}