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

生成授权凭证

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

准备工作#

在获取access_token前,需要先获取应用的client_id和client_secret:
1.登录海康云眸开发者服务
2.在秘钥管理页面,查看应用的client_id和client_secret。
img
其中 “access_token” 字段即为请求 REST API 所需的令牌,access_token生成时有效期为7天,expires_in字段表示剩余有效时间,开发者需要对access_token的有效性进行判断,若调用API时返回Http状态码为401,则说明access_token已失效,重新获取即可。
注:在使用postman调试时,注意尽量不要使用浏览器插件版本的postman,使用客户端版本的。因为插件版本的默认会使用浏览器中的cookie和缓存,可能在调用时会出现问题而难以排查。
img
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api2.hik-cloud.com/oauth/token' \
--header 'Authorization: Bearer ' \
--data-urlencode 'client_id=' \
--data-urlencode 'client_secret=' \
--data-urlencode 'grant_type='
响应示例响应示例
{
    "access_token": "62c54b72-c85f-4a4e-8fd0-6941744d0af7",
    "token_type": "bearer",
    "expires_in": 604799,
    "scope": "app"
}

请求参数

Header 参数
Authorization
string 
可选
默认值:
Bearer {{access_token}}
Body 参数application/x-www-form-urlencoded
client_id
string 
必需
客户端ID(使用云眸系统管理员账号登录开放平台门户网站open2.hik-cloud.com,进入密钥管理页面查看获取)
client_secret
string 
必需
访问密钥(使用云眸账号登录开放平台门户网站open2.hik-cloud.com,进入密钥管理页面查看获取)
grant_type
string 
必需
认证模式(目前仅支持client_credentials)
scope
string 
可选
权限范围(可选填app)

返回响应

🟢200成功
application/json
Body
access_token
string 
访问令牌
必需
token_type
string 
令牌类型
必需
expires_in
integer 
过期时间(秒)
必需
scope
string 
权限范围
可选

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

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

扫码加入交流群
上一页
接口调用说明
下一页
消息类型定义
Built with