海康云眸·社区 API
  1. 快速入门
海康云眸·社区 API
  • 产品介绍
  • 开发指南
  • 能力概览
  • 错误码表
  • 快速入门
    • 接口调用说明
    • 生成授权凭证
      POST
  • API列表
    • 消息类型定义
    • 社区管理
      • 新增社区
      • 删除社区
      • 修改社区
      • 查询社区
    • 房屋管理
      • 新增楼栋
      • 删除楼栋
      • 新增单元
      • 删除单元
      • 新增户室
      • 删除户室
      • 根据编号查询户室
      • 根据ID查询户室
      • 查询社区下的房屋
      • 查询社区下的楼栋
      • 查询楼栋下的单元
      • 查询单元下的房屋
    • 住户人人员管理
      • 新增人员
      • 删除人员
      • 修改人员
      • 设置人员所属社区
      • 删除人员所属社区
      • 设置人员所属户室
      • 删除人员所属户室
      • 重置人员所属户室
      • 获取人员户室信息
      • 人员查询
      • 获取人员标签列表
      • 设置人员标签和车牌号
    • 物业人员管理
      • 新增物业人员
      • 修改物业人员
      • 删除物业人员
    • 卡片管理
      • 新增卡片(白卡)
      • 删除卡片(白卡)
      • 开卡
      • 退卡
      • 换卡
      • 挂失
      • 解挂
      • 补卡
    • 设备管理
      • 新增设备
      • 修改设备
      • 删除设备
      • 查询设备详情
      • 查询社区下的设备列表
      • 查询社区下设备通道列表
      • 设备抓图
    • 设备确权
      • 确权流程说明
      • 自动确权
      • 下线确认
      • 上线确认
    • 广告管理
      • 下发广告
      • 删除广告
    • 超脑人脸库列表
      • 超脑人脸库列表
      • 超脑人脸库添加人脸
      • 超脑人脸库删除人脸
      • 同步超脑人脸库
    • 门禁管理
      • 获取人员门禁设备信息
      • 人脸信息下发
      • 人脸信息删除
      • 远程控门
      • 动态密码
      • 我的二维码
      • 人员权限下发
      • 人员权限删除
      • 呼梯
      • 住户人员权限批量下发
    • 访客管理
      • 访客登记(预约)
      • 访客删除
    • 第三方跳转(旧)
      • 第三方跳转登录云眸普教对接规范
    • 第三方跳转
      • 第三方跳转登录云眸普教对接规范
    • 消息通道
      • 创建消费者
      • 消费消息
      • 提交偏移量
  • 移动端SDK
    • Android
    • IOS
    • 错误码对照表
  1. 快速入门

接口调用说明

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

请求协议#

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

请求返回#

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

请求限制#

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

文档格式约定#

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

接口调用流程#

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

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

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

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