智读表API文档

物联网平台接口使用说明

api请求前缀

api请求前缀分为 中国区域海外区域 两种,具体取决于设备安装地址

区域 前缀
中国区域 https://api.smartmetering.top
海外区域 https://api.lydar.tech

http参数传递方式

方法 传递方式
GET,PUT,DELETE URL传参,例如:https://api.smartmetering.top?param1=xxx&param2=xxxx
POST Content-Type: application/x-www-form-urlencoded

平台相关参数名介绍

参数名 描述
companyId 公司Id
applicationId 应用Id(一级目录id)
productId 产品Id
productKey 产品key(二级目录key)
deviceName 设备IMEI号码(UUID序列号)

http响应结构

{
    "code":200,       //code:为200时请求成功,其他均为请求失败
    "msg":"OK",       //msg:请求状态说明
    "data":{}        //data:请求返回的数据
}

返回状态码对应错误

http状态码 错误描述
400 The parameter invalid
401 Unauthorized
404 Not Found
1001 The current page number must be greater than 0
1002 End time must be greater than start time
1003 The timestamp length is not accurate
1004 have been existed
1005 not exist
1006 file type not right
3001 username have been register
3002 email style not right
3003 email have been exist
3004 phone number style is not right
3005 phone have been exist
6003 still hava something in it
7001 tolerance scope is not satisfied
7002 points not enough
7003 file type not support
7004 tx and csv type files do not support image attributes
7005 At least one of applicationId and productKey
7006 data type id connot be empty

模块介绍

模块名称 模块作用
数据管理 历史数据查询,包括表计数据、设备错误数据查询
用户管理 用户的管理及用户授权
公司管理 公司的相关管理
应用(一级目录)管理 应用(一级目录)的管理及相关操作
产品(二级目录)管理 产品(二级目录)的管理及相关操作
设备管理 设备的管理及相关操作
设备类型管理 设备类型的管理
网络类型管理 设备网络类型相关管理
设备图片管理 设备所拍摄的表计图片相关操作
设备设置管理 设备管理模式及配置的设置
唤醒设置管理 设置唤醒周期及相关设置