帮助文档
  1. 开发者手册
  2. API调用指南（必看）
帮助文档
  • 产品介绍
    • 产品价值及介绍
    • 产品应用场景
    • 产品重点特性
    • 系统架构
    • 部署架构
    • 资质背书
  • 管理员手册
    • 入门必读
    • 第三方服务同步配置
      • 钉钉
      • 飞书
      • 企业微信
      • 腾讯会议
      • ExchangeWebService国际版
      • Outlook国际版
      • Outlook国内版
  • 功能详解
    • 我的企业
      • 概要
      • 首页
      • 通讯录
      • 空间资源
      • 权限管理
      • 安全
      • 第三方对接
      • 操作日志
      • 增值服务
    • 设备资产
      • 概要
      • 设备关联
      • 分配空间
      • 设备标签
      • 设备巡检
      • 解绑设备
    • 设备管控
      • 设备监控
      • 巡检报告
      • 设备控制
      • 设备详情
      • 定时任务
      • 告警策略
      • 远程桌面
      • 应用管理
      • 文件推送
      • 壁纸推送
      • 消息推送
      • 命令行推送
      • 弹窗拦截
      • 设备看板
      • 权限管理
      • 操作记录
    • 会议管理
      • 会议室管理
      • 会议管理
      • 预约配置
      • 通知配置
      • 门牌配置
      • 门禁配置
      • 会议数据
      • 权限管理
      • 操作记录
    • 内容宣发
      • 概要
      • 内容制作
      • 信息发布
      • 设备主页
      • 设备屏保
      • 展厅播控
      • 智能迎宾
      • 操作记录
      • 组件
    • 其他功能
      • 消息通知
      • 个人中心
      • 专属服务
  • 方案产品
    • 会议预约小程序
    • 会议预约web端
    • 腾讯会议对接
    • 设备助手
    • 门牌&门禁
    • 展厅控制屏
    • 会控屏
  • 开发者手册
    • API调用指南（必看）
      • 调用流程概述
      • 公共参数
      • 最佳实践 - 三方系统约会显示在在门牌上
      • 最佳实践 - 代码实现参考（JAVA）
    • 接口授权
      • 生成客户端令牌
    • 单点登录
      • 手机号免密登录授权
    • 通讯录管理
      • 分页查询成员
      • 查询成员
      • 根据外部id查询成员
      • 创建成员
      • 更新成员
      • 删除成员
      • 分页查询团队列表
      • 查询团队
      • 根据外部ID查询团队
      • 创建团队
      • 更新团队
      • 删除团队
      • 根据手机号查询成员id
      • 根据邮箱查询成员id
    • 空间管理
      • 更新空间
      • 分页查询空间
      • 创建空间（楼层）
      • 创建空间
      • 查询空间分类
      • 通过空间ID获取空间
      • 删除空间
      • 查询空间日程
    • 设备管理
      • 设备控制
        • 设备指令下发
      • 设备信息
        • 获取设备详情
        • 获取设备属性
        • 修改设备属性
        • 获取设备品类支持的指令集
    • 事件回调
      • 注册回调
      • 会议事件回调
      • 参会人事件回调
      • 用户签到事件回调
      • 失败记录
      • 清除失败记录
      • 查询失败记录
      • 取消回调
      • 注册回调
    • 日程管理
      • 日程
        • 创建会议日程
        • 更新会议日程
        • 取消会议日程
        • 结束会议日程
        • 会议日程签到
        • 查询会议日程详情
        • 创建周期日程
        • 取消周期日程
        • 查询周期日程
        • 更新周期日程
      • 参会人
        • 查询成员日程列表
        • 确认参加会议日程
        • 查询参会人闲忙
        • 批量删除参会人
        • 批量添加参会人
        • 拒绝参加会议日程
        • 会议日程请假
      • 签到
        • 查询会议日程的人员签到记录
      • 会议室
        • 查询会议室闲忙
        • 释放会议室
        • 预定会议室
  • 更新日志
    • 1.7.1 版本
    • 1.8.1版本
    • 1.8.6版本
  1. 开发者手册
  2. API调用指南（必看）

调用流程概述

调用流程如下图：
image.png

一、登录领效星云后台#

请访问https://saas.maxhub.com 访问领效星云后台，并创建组织

二、创建接口授权#

点击我的企业（页面上方） -> 第三方对接（左侧菜单栏） -> 接口授权(子菜单)，创建授权并配置接口权限
image.png

三、公共参数#

公共参数是用于接口鉴权目的的参数，如非必要，在每个接口单独的接口文档中不再对这些参数进行说明，但每次请求均需要携带这些参数，才能正常发起请求。
API 采用 TX 的 TC3-HMAC-SHA256 签名方法，公共参数需要统一放到 HTTP Header 请求头部中。
具体参数格式参考：公共参数

四、获取访问令牌#

调用所有API接口前都需要先创建访问令牌token，token的有效期为2小时。请一定要缓存该token，频繁申请token会被识别IP做限流处理
接口详情：生成客户端令牌
image.png

五、调用接口#

将第三步获取到的token添加到http请求头中，调用所需要的接口
image.png

六、最佳实践案例#

在开发前请参考最佳实践，预计可提高开发速度50%以上
最佳实践 - 三方系统约会显示在在门牌上

备注#

如果领效星云私有化部署，请将api.maxhub.com域名 -> 服务器ip:28801
修改于 2024-12-25 09:19:01
上一页
会控屏
下一页
公共参数