瀚云API

使用手册

我们推荐您使用Java-SDK接入瀚云进行相关体验。为了更好掌握使用方法，建议请先阅读SDK快速入门文档。点击这里

HTTP协议API网关地址

    https://api.hanclouds.com/api/v1
    http://api.hanclouds.com/api/v1

设备配置API公网地址

    http://api.hanclouds.com/api/configSpace
    https://api.hanclouds.com/api/configSpace

图片API网关地址

    https://api.hanclouds.com/image/v1

所有API路径均为以上网关地址 + API路径，以获取服务器时间为例，请求路径为:

https://api.hanclouds.com/api/v1/now

当前网关支持https加密与http非加密方式，可以根据自己情况自行选用。

在进行API调用前，请先了解 平台授权信息

公共功能

API	路径	方法
推送服务授权	/pushsvcs/createAuthToken	POST
服务器时间	/now	GET
MQTT服务地址	/mqttGatewayIps	GET

项目

API	路径	方法
获取用户下的项目列表	/projects	GET
获取项目详情	/projects/{projectKey}	GET
获取项目下的产品列表	/projects/{projectKey}/products	GET
获取项目下的产品总数	/projects/{projectKey}/productNum	GET

产品

API	路径	方法
获取自有产品列表	/products	GET
修改产品信息	/products/{productKey}	PUT
停用产品	/products/{productKey}/disable	POST
启用产品	/products/{productKey}/enable	POST
创建设备	/products/{productKey}/devices	POST
查询产品的设备列表	/products/{productKey}/devices	GET
获取产品的设备在线数	/products/{productKey}/onlineDeviceNum	GET
获取产品的上行数据总数	/products/{productKey}/dataTotalNum	GET
获取产品HTTP推送的秘钥	/products/{productKey}/dataSecret	GET

设备

API	路径	方法
重置鉴权ACK	/devices/{deviceKey}/createAck	DELETE
获取设备上传过数据的数据流模型	/devices/{deviceKey}/datastreams	GET
设备是否在线	/devices/{deviceKey}/isOnline	GET
设置鉴权ACK	/devices/{deviceKey}/createAck	POST
停用设备	/devices/{deviceKey}/disable	POST
强制设备下线	/devices/{deviceKey}/offline	POST
获取设备命令下行总数	/devices/{deviceKey}/commandNum	GET
根据产品key和设备sn获取设备信息	/devices/{productKey}/{sn}	GET
根据设备key获取设备信息	/devices/{deviceKey}	GET
根据设备key获取设备信息V2	/devices/detail/{deviceKey}	GET
修改设备信息	/devices/{deviceKey}	PUT
获取在线设备数	/devices/userKey/{userKey}/findDeviceOnline	POST

产品数据流

API	路径	方法
获取产品数据流列表	/products/{productKey}/datastreams	GET
获取单个产品数据流	/products/{productKey}/datastreams/{dataName}	GET
搜索数据流	/products/{productKey}/datastreams/search/{dataName}	GET
分页查询数据流模板	/dataStream/template/{productKey}/page	GET

设备命令

API	路径	方法
获取多个命令	/devices/{deviceKey}/commandsFilters/byCommandIds	POST
获取设备命令	/devices/{deviceKey}/commands/{commandId}	GET
最近设备命令	/devices/{deviceKey}/latestCommands	GET
查询设备命令	/devices/{deviceKey}/commands	GET
自定义下发设备命令	/devices/{deviceKey}/commands	POST
根据命令模板下发设备命令	/devices/{deviceKey}/commands/{identifier}	POST

设备事件

API	路径	方法
获取设备事件列表	/devices/{deviceKey}/events	GET
获取设备最新事件	/devices/{deviceKey}/latestEvents	GET
查询设备最后上线时间	/devices/{deviceKey}/lastConnectTime	GET

设备数据

API	路径	方法
获取设备数据流的数据列表	/devices/{deviceKey}/datastreams/{dataName}/data	GET
获取产品的设备数据流列表	/devices/{productKey}/deviceData	GET
获取设备数据流的最新数据	/devices/{deviceKey}/datastreams/{dataName}/latestData	GET
查询设备上行数据总数	/devices/{deviceKey}/dataTotalNum	GET
设备上传数据	/devices/{deviceKey}/datastreams/{dataName}/data	POST

设备配置

API	路径	方法	鉴权方式
设备端获取最新版本	/device/config/latestVersionByDevice	POST	设备鉴权
设备端拉取配置	/device/config/pullByDevice	POST	设备鉴权
添加设备配置	/device/config	POST	配置空间鉴权
更新设备配置	/device/config/update	PUT	配置空间鉴权
重置设备配置	/device/config/reset	POST	配置空间鉴权
获取最新版本	/device/config/latestVersion	POST	配置空间鉴权
拉取设备配置	/device/config/pull	POST	配置空间鉴权

设备图片数据

API	路径	方法
上传图片	/devices/{deviceKey}/datastreams/{dataName}/images	POST
下载单张图片	/devices/{deviceKey}/datastreams/{dataName}/images/{imgId}	GET
下载最新图片	/devices/{deviceKey}/datastreams/{dataName}/latestImage	GET
获取最新图片的元数据	/devices/{deviceKey}/datastreams/{dataName}/latestMetaData	GET
获取图片元数据列表	/devices/{deviceKey}/datastreams/{dataName}/metadata	GET
查询设备图片总数	/devices/{deviceKey}/imageTotalNum	GET
查询设备某个数据流图片总数	/devices/{deviceKey}/datastreams/{dataName}/imageTotalNum	GET

告警事件

API	路径	方法
分页获取告警事件列表	/devices/{deviceKey}/alertEvents/{eventIdentifier}/data	GET
获取最近的告警事件列表	/devices/{deviceKey}/alertEvents/{eventIdentifier}/latestData	GET
查询告警事件总数	/devices/{deviceKey}/alertEventsNum	GET
设备上报告警	/devices/{deviceKey}/alertEvents/{eventIdentifier}/data	POST

设备档案

API	路径	方法
批量添加设备档案	/archives/batch	POST
查询设备的所有档案	/archives/{deviceKey}	GET
根据档案ID查询设备档案	/archives/{deviceKey}/id	GET
根据档案模板ID查询设备档案	/archives/{deviceKey}/template	GET
批量删除设备档案	/archives/{deviceKey}/batch	DELETE

视频设备

API	路径	方法
分页获取视频通道列表	/videos/{deviceKey}/channelList	GET
同步视频通道	/videos/{deviceKey}/syncChannel	POST
获取实时播放地址	/videos/{deviceKey}/streamStart	GET
开始设备控制	/videos/{deviceKey}/ptzCmdStart	POST
停止设备控制	/videos/{deviceKey}/ptzCmdEnd	POST
分页获取本地录像列表	/videos/{deviceKey}/queryRecordList	GET
获取本地录像播放地址	/videos/{deviceKey}/startVideoBackByTime	GET
本地录像控制	/videos/{deviceKey}/queryRecordList	POST
获取视频截图	/videos/{deviceKey}/getSnap	POST
开始视频录像	/videos/{deviceKey}/startRecord	POST
结束视频录像	/videos/{deviceKey}/stopRecord	POST
视频录像下载	/videos/{deviceKey}/getRecord	POST

档案模板

API	路径	方法
添加档案模板	/archives/template/{projectKey}	POST
更新档案模板	/archives/template/{templateId}	PUT
删除档案模板	/archives/template/{templateId}	DELETE
分页查询档案模板	/archives/template/{projectKey}	GET

物联卡

API	路径	方法
物联卡使用列表	/card/use/list	GET