海康云眸·连锁 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. 快速入门

生成授权凭证

生成授权凭证(access_token)#


在调用服务端API前,需要先调用获取token接口获取access_token,通过access_token来鉴权调用者身份。
在使用access_token时,请注意:         
1. access_token的有效期为604800秒(7天),有效期内重复获取返回相同结果,过期后获取会返回新的access_token。      
2. 开发者需要缓存access_token,用于后续接口的调用。当access_token失效或过期时,接口会返回http状态码401,需要重新获取access_token。      
3. 不能频繁调用获取access_token接口,否则会受到接口调用频率拦截。

准备工作#


在获取access_token前,需要先获取应用的client_id和client_secret:
1.
登录海康云眸开发者服务
2.
在秘钥管理页面,查看应用的client_id和client_secret。
image.png

生成access_token#


请求方式: POST application/x-www-form-urlencoded
请求地址 https://api2.hik-cloud.com/oauth/token
请求参数:
属性名称属性描述类型长度是否必填备注
client_id客户端IDString32是使用云眸系统管理员账号登录开放平台门户网站open2.hik-cloud.com,进入密钥管理页面查看获取
client_secret访问密钥String32是用云眸账号登录开放平台门户网站open2.hik-cloud.com,进入密钥管理页面查看获取
grant_type认证模式String32是目前仅支持client_credentials
scope权限范围Srting32否可选填app
返回数据
属性名称属性描述类型长度是否必填
access_token访问令牌String32是
token_type令牌类型String32是
expires_in过期时间(秒)Long8是
scope权限范围String32否
响应示例
1. {
2.     "access_token": "62c54b72-c85f-4a4e-8fd0-6941744d0af7",
3.     "token_type":"bearer",  
4.     "expires_in": 604799,
5.     "scope":"app"  
6. }
其中 “access_token” 字段即为请求 REST API 所需的令牌,access_token生成时有效期为7天,expires_in字段表示剩余有效时间,开发者需要对access_token的有效性进行判断,若调用API时返回Http状态码为401,则说明access_token已失效,重新获取即可。

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

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

扫码加入交流群
上一页
常见问题
下一页
接口调用说明
Built with