海康云眸·普教 API
  1. 快速入门
海康云眸·普教 API
  • 产品介绍
  • 能力概览
  • 错误码表
  • 快速入门
    • 接口调用说明
    • 生成授权凭证档
    • 生成access_token
      POST
  • 开发指南
    • 消息通道
    • 接口说明
      • 请求数据
      • 认证管理
  • API列表
    • 基础服务
      • 学校管理
        • 查询学校(教育局)信息
        • 查询教育局下的学校信息
        • 第三方公众号token更新
      • 班级管理
        • 新增班级
        • 修改班级
        • 删除班级
        • 查询班级信息
        • 班级毕业
        • 班级升级
      • 部门管理
        • 新增部门
        • 删除部门
        • 修改部门
        • 查询部门信息
      • 教职工管理
        • 新增教职工
        • 删除教职工
        • 修改教职工
        • 查询教职工信息
        • 教职工部门调整
      • 学生管理
        • 新增学生
        • 删除学生
        • 修改学生
        • 查询学生信息
        • 学生调班
        • 通过学号获取学生信息
        • 添加教学班学生
        • 删除教学班学生
        • 查询教学班学生信息
      • 家长管理
        • 新增家长
        • 删除家长
        • 修改家长
        • 查询家长信息
      • 设备管理
        • 查询所有设备组织
        • 查询设备监控通道
        • 查询家长关联设备信息
        • 查询学校中设备信息
        • 添加设备(非物联设备)
        • 删除设备(非物联设备)
        • 查询学校中指定类型设备数量
        • 远程开门
        • 查询场地空气质量
        • 物联能耗数据查询
        • 物联设备控制接口
      • 设备确权
        • 确权流程说明
        • 自动确权
        • 下线确认
        • 上线确认
      • 场地管理
        • 新增场地
        • 删除场地
        • 修改场地
        • 查询场地信息
        • 场地中新增人员
        • 场地中删除人员
      • 用户管理(旧)
        • 默认角色列表
        • 新增用户
        • 删除用户
        • 修改用户信息
        • 获取登录码
      • 用户管理
        • 默认角色列表
        • 变更说明
        • 新增用户
        • 删除用户
        • 修改用户信息
        • 获取登录码
        • 批量查询UserId
    • 视频接入
      • 获取视频直播地址
      • 获取视频预览地址
      • 局端下属学校取流认证
    • 学生请假管理
      • 新增请假单
      • 删除请假单
      • 查询学生请假信息
    • 教学管理
      • 课表管理
        • 课表数据同步
        • 课表数据同步结果查询
        • 家长读取学生的课表信息
        • 查询行政班或教学班的课表
      • 课程库管理
        • 查询行政班或教学班的班级课程库
        • 查询校本课程库信息
        • 查询校本课程库详细信息
        • 删除班级课程
        • 添加班级课程
        • 修改班级课程
        • 删除校本课程库
        • 添加校本课程库
        • 修改校本课程库
        • 删除校本课程
        • 添加校本课程
        • 修改校本课程
      • 查询学期信息
    • 门禁权限管理
      • 门禁权限下发
    • 电子班级
      • 班级管理
        • 人脸识别参数配置
        • 获取资源类发布内容
        • 获取相册类发布内容
        • 获取视频类发布内容
        • 发布资源类内容(班级公告、校园宣传、紧急通知、校园新闻、校园公告、学习资料)
        • 发布相册类内容(班级相册、校园相册)
        • 发布视频类内容(班级视频、校园视频)
        • 发布考试计划
        • 撤销发布内容
        • 发布班级值日信息
        • 发布倒计时(班级倒计时、校园倒计时)
        • 添加班级值日项信息
        • 查询值日项信息
        • 修改班级值日项信息
        • 删除班级值日项信息
      • 留言管理
        • 新增留言
        • 家长读取学生的留言记录
    • 访客管理
      • 访客预约登记
      • 删除访客预约
    • 第三方跳转(旧)
      • 第三方跳转登录云眸普教对接规范
    • 第三方跳转
      • 第三方跳转登录云眸普教对接规范
    • 消息通道
      • 创建消费者
      • 消费消息
      • 提交偏移量
    • 消息类型定义
      • 消息类型定义
  • 移动端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/edu/basic/schools
         请求包体:
         ...
         参数说明:
         ...
         返回结果:
         ...
         参数说明
         ...
        
**·请求方式:**接口使用的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