海康云眸·连锁 API
  1. 快速入门
海康云眸·连锁 API
  • 产品介绍
  • 能力概览
  • 错误码表
  • 常见问题
  • 快速入门
    • 生成授权凭证
    • 接口调用说明
    • 生成access_token
      POST
  • 开发指南
    • 接口说明
    • 消息通道
  • 视频服务能力
    • 视频设备配置指南
    • 视频对接指南
    • 直播服务
    • 微信小程序接入视频服务
    • 视频集成方案
      • web视频控件
      • UIKIT
      • 标准流预览
      • 移动端SDK
        • Android
        • 错误码对照表
        • iOS
    • 直播服务
      • 开通直播间
      • 通过通道ID获取直播间地址
      • 关闭设备加密
    • 微信小程序接入视频服务
      • 1.开发指南
      • 2.小程序开发
      • 3.接口说明
        • 获取直播/回放RTMP地址
    • 取流认证
      GET
  • 设备数据
    • 修改通道名称
      POST
    • 通过门店ID查询设备通道列表
      GET
    • 通过门店编号查询设备通道列表
      GET
    • 查询所有设备通道列表
      GET
    • 通过设备序列号查询通道列表
      GET
    • 通过设备序列号查询设备录像存储记录
      GET
  • 设备能力
    • 云台控制
      • 开始云台控制
      • 停止云台控制
      • 根据通道Id查询预置点列表
      • 新增预置点
      • 调用预置点
      • 删除预置点
    • 设备抓图
      • 设备抓图
    • 修改报警能力开关
      • 修改报警能力开关
    • IO管理
      • 获取设备IO端口状态
      • 获取设备指定输出口信息
      • 配置设备指定输出口信息
      • IO输出
    • 探测器
      • 查询网关下探测器列表
      • 网关关联子设备
      • 网关解绑子设备
      • 修改子设备名称
      • 设置传感器状态
    • 云存储
      • 开通云存储
  • 门店数据
    • 获取门店列表
    • 门店布撤防状态查询
  • 客流统计
    • 通过门店ID查询客流数据
    • 通过门店编号查询客流数据
    • 查询客流数据
  • 区域热度
    • 查询区域热度配置
    • 查询驻足人次分布
    • 生成热度图
    • 获取热度图
    • 获取区域关注度配置
    • 区域关注度配置
  • POS单
    • POS单信息录入
  • 巡查服务
    • 查询自动抓图的图片数据
  • 开门事件
    • 开门事件
  • 消息通道
    • 创建消费者
    • 消费消息
    • 接口定义
    • 提交偏移量
  • 消息类型定义
    • 设备报警消息
  • 智能分析AI能力
    • 查询模型列表
    • 查询算法模型的训练版本
    • 获取算法训练版本详情
    • 图片回传
  • 身份认证
    POST
  • 获取门店区域组织节点全量列表
    GET
  1. 快速入门

接口调用说明

接口调用说明#


本文介绍了云眸开放平台服务端接口的调用方式及接口文档的相关格式说明。

请求协议#


请求的协议建议为https,如果使用http,服务器端会返回301引导客户端进行重定向,而某些开发语言的解析框架无法自动转向,还需要编码。所以建议第三方直接使用https协议。

请求返回#


1.
请求返回的HTTP状态码为200表示请求成功,非200的错误码则为请求错误,例如401为认证失败,需要重新获取token,429为接口请求频率超过限制,500为服务端错误,503为服务不可用
2.
请求返回数据中的code为200时表示请求成功,返回非200的code则需要对照错误码表进行判断,一般返回的message中已有错误信息的说明

请求限制#


为避免请求过多造成服务阻塞,每个用户的请求都会受到限流,默认限流次数为100次/分钟

文档格式约定#


每个接口文档会按照如下格式提供信息:
1. 请求方式:GET/POST          
2. 请求地址:https://api2.hik-cloud.com/api/v1/open/basic/groups/create        
3. 请求包体:
4. ... 
5. 参数说明:      
6. ... 
7. 返回结果:      
8. ... 
9. 参数说明      
10. ...
·请求方式:接口使用的HTTP方法和请求协议。所有接口都使用HTTPS协议。
·请求地址:接口的请求地址。云眸开放平台服务端接口的访问域名为https://api2.hik-cloud.com。
·请求包体/参数说明:提供请求参数示例及说明,参数说明包括字段名称、类型、描述等。
·返回结果/参数说明:提供返回参数示例及说明。
注意:
1. 所有接口(获取access_token接口除外)在调用时都会返回code、message和data,其中code=200时说明该接口调用成功,而code非200时则说明该接口业务调用异常,开发者可根据code和message排查问题。
2. 请不要仅根据message判断调用是否成功。当请求返回结果中返回了code且不为200时可判断为请求失败。message是对code的说明,供开发者参考排查问题。

接口调用流程#

如下图所示,在调用云眸开放平台服务端接口前,您需要完成以下准备工作:
1.
拿到可登陆云眸开发者服务的用户名和密码, 并登陆海康云眸开发者服务
2.
获取授权凭证(access_token)。 access_token相当于是身份凭证,调用接口时,通过access_token来鉴权调用者身份。
image.png
3.
access_token传参方式说明
所有服务端接口(获取access_token接口除外)请求时都需要将access_token放入Request Headers中Authorization属性中, 并在access_token前面加上Bearer且空格隔开,示图如下:
image.png

【海康云眸】API开发者 微信交流群

用微信扫右侧二维码,加入【海康云眸】API开发者 交流群,互助沟通

扫码加入交流群
上一页
生成授权凭证
下一页
生成access_token
Built with