OPEN API是温湿度监控平台 推出的服务开放接口,任何第三方应用或网站都可以通过使用开放API为用户提供实时优质的服务。 API支持主流的方式,可兼容多种编程语言。

基础介绍

  1. 鉴权方式:HTTP Basic Auth
  2. URL: http://t-api.tzonedigital.cn
  3. 账号:注册链接

一、接口说明

URL HTTP 功能
/openapi/openapi Get 得到OpenAPI信息
  1. 得到OpenAPI信息

    Get /openapi/openapi

    参数

    名称 类型 必填 描述
    access_token String 密钥

    示例

    curl http://t-api.tzonedigital.cn/openapi/openapi?access_token=xxxx -method get

    全局返回参数说明

    名称 类型 必填 描述
    Status Int 状态 Status=0时,代表错误;Status=1时,代表正常
    Msg String 当Status=0时,提示错误说明
    Content String 内容

    密钥验证错误

    {"Status":0,"Msg":"access_token is error !","Content":""}

    返回值

    名称 类型 必填 描述
    UserID Int 用户编号
    TV Int 总使用量
    DV Int 今日使用量
    Version String OpenAPI版本
    CreateTime DateTime 密钥创建时间
    {"Status":1,"Msg":"","Content":"{"UserID":2,"TV":0,"DV":0,"Version":"1.0.0","CreateTime":"2019-02-25T08:58:06"}"}

二、用户/Users

URL HTTP 功能
/openapi/user Get 得到用户信息
  1. 得到用户信息

    Get /openapi/user

    示例

    curl http://t-api.tzonedigital.cn/openapi/user?access_token=xxxx -method get

    返回值

    名称 类型 必填 描述
    ID Int 用户编号
    UserName String 用户名
    Email String 邮箱
    Tel String 电话号码
    IsLocked Bool 帐号是否锁定
    FailedCount Int 连续输出密码错误次数
    LastLoginTime Long 最后一次登录时间
    EnterIP String 最后一次登录IP
    CreateTime Long 用户帐号创建时间
    TimeZone Double 用户设置时区
    Language String 用户设置语言
    {"Status":1,"Msg":"","Content":"{"ID":2,"UserName":"demo","Email":"demo@tzonedigital.com","Tel":"15012461234","IsLocked":false,"FailedCount":0,"LastLoginTime":1470120433000,"EnterIP":"1.1.1.1","CreateTime":1470120433000,"TimeZone":"8","Language":"zh_CN"}"}

三、组/Groups

URL HTTP 功能
/openapi/users/me/groups GET 组列表
/openapi/users/me/groups POST 添加组
/openapi/users/me/groups/:id DELETE 删除组
/openapi/users/me/groups/:id PUT 修改组
  1. 组列表

    GET /openapi/users/me/groups

    示例

    curl http://t-api.tzonedigital.cn/openapi/users/me/groups?access_token=xxxx -method get

    返回值

    {"Status":1,"Msg":"","Content": "{"PageSize":1000,"PageIndex":1,"TotalCount":0,"TotalPage":0,"ResultList":null}"}

  2. 添加组

    POST /openapi/users/me/groups

    参数

    名称 类型 描述 必填
    GroupName String 组名称
    ParentID Int 父编号(默认为0)
    SortID Int 排序(序号越大排在前面)
    Description String 描述

    示例

    curl http://t-api.tzonedigital.cn/openapi/users/me/groups?access_token=xxxx -method post -body '{"GroupName":"Test","ParentID":0,"SortID":0,"Description":"test"}'

    返回值

    {"Status":1,"Msg":"添加成功","Content":""}

  3. 删除组

    DELETE /openapi/users/me/groups/:id

    示例

    curl http://t-api.tzonedigital.cn/openapi/users/me/groups/0?access_token=xxxx -method delete

    返回值

    {"Status":1,"Msg":"删除成功","Content":""}
  4. 修改组

    PUT /openapi/users/me/groups/:id

    参数

    名称 类型 描述 必填
    GroupName String 组名称
    ParentID Int 父编号(默认为0)
    SortID Int 排序(序号越大排在前面)
    Description String 描述

    示例

    curl http://t-api.tzonedigital.cn/openapi/users/me/groups/0?access_token=xxxx -method put -body '{"GroupName":"Test","ParentID":0,"SortID":0,"Description":"test"}'

    返回值

    {"Status":1,"Msg":"修改成功","Content":""}

四、设备类型/ProductType

URL HTTP 功能
/openapi/producttype GET 设备类型
  1. 设备类型

    GET /openapi/producttype

    示例

    curl http://t-api.tzonedigital.cn/openapi/producttype?access_token=xxxx -method get

    返回值

    名称 类型 必填 描述
    ID Int 类型编号
    TypeName String 类型名称
    {"Status":1,"Msg":"","Content":"[{"ID":14,"TypeName":"TZ-LORAWAN","Model":"LORAWAN","IsDelete":0},{"ID":13,"TypeName":"TZ-TAG07C","Model":"TAG07C","IsDelete":0},{"ID":12,"TypeName":"TZ-TT11B","Model":"TT11B","IsDelete":0},{"ID":11,"TypeName":"TZ-D01","Model":"D01","IsDelete":0},{"ID":10,"TypeName":"TZ-LoRa","Model":"LoRa","IsDelete":0},{"ID":9,"TypeName":"TZ-TAG06B","Model":"TAG06","IsDelete":0},{"ID":8,"TypeName":"TZ-TAG06","Model":"TAG06","IsDelete":0},{"ID":7,"TypeName":"TZ-TAG05","Model":"TAG05","IsDelete":0},{"ID":6,"TypeName":"TZ-TT03","Model":"TT03","IsDelete":0},{"ID":5,"TypeName":"TZ-TT01","Model":"TT01","IsDelete":0},{"ID":4,"TypeName":"TZ-BT04","Model":"BT04","IsDelete":0},{"ID":3,"TypeName":"TZ-TAG04","Model":"TAG04","IsDelete":0},{"ID":2,"TypeName":"TZ-TT18","Model":"TT18","IsDelete":0},{"ID":1,"TypeName":"TZ-TT11","Model":"TT11","IsDelete":0}]"}

五、设备/Products

URL HTTP 功能
/openapi/users/me/products GET 设备列表
/openapi/users/me/products/:id GET 得到设备
/openapi/users/me/products POST 添加设备
/openapi/users/me/products/:id DELETE 删除设备
/openapi/users/me/products/:id PUT 修改设备
  1. 设备列表

    GET /openapi/users/me/products

    参数

    名称 类型 描述 必填
    PageIndex Int 分页编号
    PageSize Int 分页大小
    GroupId Int 组编号
    Keys Int 关键字

    示例

    curl http://t-api.tzonedigital.cn/openapi/users/me/products?PageIndex=1&PageSize=1000&GroupId=0&Keys=key&access_token=xxxx -method get

    返回值

    名称 类型 必填 描述
    PageSize Int 每页数量
    PageIndex Int 第几页
    TotalCount Int 总数量
    TotalPage Int 页数
    ID Int 产品编号
    IMEI String IMEI/SN
    ProductName String 产品名称
    TypeID Int 类型编号
    GroupID Int 组编号
    GroupName String 组名称
    Description String 描述
    CreateTime Long 创建时间
    ExpireTime Long 过期时间
    {"Status":1,"Msg":"","Content":"{"PageSize":1000,"PageIndex":1,"TotalCount":2,"TotalPage":1,"ResultList":[{"ID":20,"IMEI":"06160219","ProductName":"一区","TypeID":8,"GroupID":7,"GroupName":"北京","CreateTime":1470363960000,"ExpireTime":1506583200000,"IsExpire":1,"Description":""},{"ID":19,"IMEI":"866104024649132","ProductName":"TT18_office test 1","TypeID":2,"GroupID":6,"GroupName":"深圳","CreateTime":1470120259000,"ExpireTime":1517781300000,"IsExpire":1,"Description":""}]}"}
  2. 得到设备

    GET /openapi/users/me/products/:id

    示例

    curl http://t-api.tzonedigital.cn/openapi/users/me/products/0?access_token=xxxx -method get

    返回值

    名称 类型 必填 描述
    ID Int 产品编号
    IMEI String IMEI/SN
    ProductName String 产品名称
    TypeID Int 类型编号
    GroupID Int 组编号
    GroupName String 组名称
    Description String 描述
    CreateTime Long 创建时间
    ExpireTime Long 过期时间
    {"Status":1,"Msg":"","Content":"{"ID":20,"IMEI":"06160219","ProductName":"一区","TypeID":8,"GroupID":7,"GroupName":"北京","CreateTime":1470363960000,"ExpireTime":1506583200000,"IsExpire":1,"Description":""}"}
  3. 添加设备

    POST /openapi/users/me/products

    参数

    名称 类型 描述 必填
    IMEI String 设备IMEI/TagID/SN
    ProductName String 设备名称
    TypeID Int 设备类型编号
    GroupID Int 组编号
    TerminalDataInterval Int 终端数据间隔
    TerminalPassword String 终端密码
    Description String 描述

    示例

    curl http://t-api.tzonedigital.cn/openapi/users/me/products?access_token=xxxx -method post -body '{"IMEI":"06160219","ProductName":"一区","TypeID":8,"GroupID":7,"TerminalPassword":"000000","TerminalDataInterval":15,"Description":""}'

    返回值

    {"Status":1,"Msg":"添加成功","Content":""}

  4. 删除设备

    DELETE /openapi/users/me/products/:id

    示例

    curl http://t-api.tzonedigital.cn/openapi/users/me/products/0?access_token=xxxx -method delete

    返回值

    {"Status":1,"Msg":"删除成功","Content":""}
  5. 修改设备

    PUT /openapi/users/me/products/:id

    参数

    名称 类型 描述 必填
    ProductName String 设备名称
    TypeID Int 设备类型编号
    GroupID Int 组编号
    TerminalDataInterval Int 终端数据间隔
    TerminalPassword String 终端密码
    Description String 描述

    示例

    curl http://t-api.tzonedigital.cn/openapi/users/me/groups/0?access_token=xxxx -method put -body '{"ProductName":"一区","TypeID":8,"GroupID":7,"TerminalPassword":"000000","TerminalDataInterval":15,"Description":""}'

    返回值

    {"Status":1,"Msg":"修改成功","Content":""}

六、设备数据/TerminalData

URL HTTP 功能
/openapi/terminaldata/realtime GET 所有设备实时数据
/openapi/terminaldata/realtime/:id GET 设备实时数据
/openapi/terminaldata/history/:id GET 设备历史数据
  1. 所有设备实时数据

    GET /openapi/terminaldata/realtime

    参数

    名称 类型 描述 必填
    PageIndex Int 分页编号
    PageSize Int 分页大小

    示例

    curl http://t-api.tzonedigital.cn/openapi/terminaldata/realtime?PageIndex=1&PageSize=1000&access_token=xxxx -method get

    返回值

    名称 类型 必填 描述
    PageSize Int 每页数量
    PageIndex Int 第几页
    TotalCount Int 总数量
    TotalPage Int 页数
    PID Int 设备编号
    Temperature Double 温度值;当值=-1000,代表为空!
    Humidity Double 湿度值;当值=-1000,代表为空!
    L_wgs84 String 经纬度
    L_lbs String 基站信息
    Voltage Double 电压值;当值=-1000,代表为空!
    Battery Int 电池电量;由电压估算出来,仅参考。
    RSSI Int 信号强度;当值=-1000,代表为空!
    RTC Long 设备上报数据时间
    ServerTime Long 服务器接收数据时间
    {"Status":1,"Msg":"","Content":"{"PageSize":1000,"PageIndex":1,"TotalCount":1,"TotalPage":1,"ResultList":[{"ID":6,"PID":19,"Temperature":-10.51,"Humidity":55.00,"Voltage":4.13,"Battery":90.00,"RSSI":-1000,"RTC":1470148558000,"ServerTime":1470120433000}]}"}
  2. 设备实时数据

    GET /openapi/terminaldata/realtime/:id

    示例

    curl http://t-api.tzonedigital.cn/openapi/terminaldata/realtime/0?access_token=xxxx -method get

    返回值

    名称 类型 必填 描述
    PID Int 设备编号
    IMEI String 设备IMEI/TagID/SN
    ProductName String 设备名称
    TypeID Int 设备类型编号
    GroupID Int 组编号
    CreateTime Long 创建时间
    ExpireTime Long 到期时间
    IsExpire Bit 是否到期
    Description String 描述
    Temperature Double 温度值;当值=-1000,代表为空!
    Humidity Double 湿度值;当值=-1000,代表为空!
    L_wgs84 String 经纬度
    L_lbs String 基站信息
    Voltage Double 电压值;当值=-1000,代表为空!
    Battery Int 电池电量;由电压估算出来,仅参考。
    RSSI Int 信号强度;当值=-1000,代表为空!
    RTC Long 设备上报数据时间
    ServerTime Long 服务器接收数据时间
    {"Status":1,"Msg":"","Content":"{"ID":6,"IMEI":"0006","ProductName":"TH-0006","TypeID":2,"GroupID":5,"CreateTime":1454297116000,"ExpireTime":1457580316000,"IsExpire":1,"Description":"TH-0006","Temperature":"28.25","Humidity":"48","L_wgs84":"","L_lbs":"","Voltage":"0","Battery":"0","RSSI":"--","RTC":1466750223000,"ServerTime":1466750411000}"}
  3. 设备历史数据

    GET /openapi/terminaldata/history/:id

    参数

    名称 类型 描述 必填
    PageIndex Int 分页编号
    PageSize Int 分页大小
    BeginTime DateTime 起始时间,格式:yyyy/MM/dd HH:mm:ss UTC时间
    EndTime DateTime 结束时间,格式:yyyy/MM/dd HH:mm:ss UTC时间

    示例

    curl http://t-api.tzonedigital.cn/openapi/terminaldata/history/0?access_token=xxxx -method get

    返回值

    名称 类型 必填 描述
    PageSize Int 每页数量
    PageIndex Int 第几页
    TotalCount Int 总数量
    TotalPage Int 页数
    ID Int 编号
    Temperature Double 温度值;当值=-1000,代表为空!
    Humidity Double 湿度值;当值=-1000,代表为空!
    L_wgs84 String 经纬度
    L_lbs String 基站信息
    Voltage Double 电压值;当值=-1000,代表为空!
    Battery Int 电池电量;由电压估算出来,仅参考。
    RSSI Int 信号强度;当值=-1000,代表为空!
    RTC Long 设备上报数据时间
    ServerTime Long 服务器接收数据时间
    {"Status":1,"Msg":"","Content":"{"PageSize":1000,"PageIndex":1,"TotalCount":1,"TotalPage":1,"ResultList":[{"ID":6,"Temperature":-10.51,"Humidity":55.00,"L_wgs84":"","L_lbs":"","Voltage":4.13,"Battery":90.00,"RSSI":-1000,"RTC":1470148558000,"ServerTime":1470120433000}]}"}