向日葵开放API
贝锐企业+试用向日葵企业管理平台
贝锐企业+试用向日葵企业管理平台
  1. 开发者必读
  • 📃 简介
  • 🌐 管理平台API
    • 开发者必读
      • 流程概述
      • 接入准备
      • 平台签名校验
      • 用户身份校验
      • 错误码对照表
    • 用户身份授权API
      • 身份授权
      • 续租授权
    • 核心服务API
      • 设备信息管理
        • 创建/取消主机授权
        • 获取主机列表
        • 获取单个主机基本信息
        • 修改主机
        • 删除主机
        • 查询主机状态
      • 审计日志查询
        • 查询远程日志列表
        • 查询被控端(上下线)日志列表
        • 查询被控日志
        • 查询控制端最近登录日志
        • 查询文件传输日志
        • 查询操作日志
      • 资产信息查询
        • 查询IT资产列表
        • 根据资产ID查询是否有变更数据
        • 查询IT资产变更历史
      • 坐席服务管理
        • 新增坐席成员
        • 更新坐席成员
        • 查询坐席成员-列表
        • 删除坐席星标客户
        • 删除坐席成员
        • 强制下线-坐席成员
        • 查询坐席星标客户-列表
        • 查询坐席日志
      • 设备分组管理
        • 查询主机关联的分组
        • 创建主机与分组的关联
        • 创建分组
        • 删除主机与分组的关联
        • 修改分组
        • 删除分组
        • 查询分组的列表
      • 企业子账号管理
        • 子账号身份授权
        • 修改子账号信息
        • 创建企业子账号
        • 删除企业子账号
        • 查询子账号列表
        • 获取指定子账号信息
        • 查询账号分组的功能模块列表
        • 修改指定的分组功能模块
        • 获取角色分组列表
        • 新增角色分组
        • 更新角色分组
        • 删除角色分组
        • 获取组织部门列表
        • 创建部门
        • 修改部门
        • 删除部门
        • 获取功能模块列表
        • 修改企业账号密码
    • 硬件API
      • 获取插座用电量
      • 开关插座
      • 获取插座状态
  • 💻 客户端本地API
    • 开发者必读
      • 接入指南
    • 服务端API
      • 开发指南
        • 如何调用服务端API
        • 服务端API错误码对照表
      • 获取访问凭证
        • 获取客户端API访问凭证
    • 客户端API
      • 开发指南
        • 如何调用客户端API
        • 客户端API报文加解密流程
        • 客户端API错误码对照表
      • 向日葵企业主控端能力
        • 主控端调起协议
        • 指定设备ID/识别码发起远控
        • 在设备列表中定位指定设备ID并发起远控
        • 检测应用程序是否存活
      • 向日葵企业被控端能力
        • 获取当前设备信息
    • 参考
      • 调用过程及示例代码
  1. 开发者必读

用户身份校验

PaaS 平台提供了针对当前贝锐产品的交互能力,调用这一类服务时必须在请求中附带被操作用户的身份授权。本文描述平台 HTTP API 的身份验证机制以及调用规范。

基本概念#

访问令牌#

访问令牌 (AccessToken)是直接代表用户请求信息的凭证。访问令牌是一个 JWT格式的字符串,详细信息参见RFC 7519。
其中用户需要关注 Claims 中的 exp(Expires),该字段是一个 UnixTimestamp,其标识了访问令牌的过期时间,请求发起前调用者需要知道 AccessToken 是否过期,若过期了需要进行刷新。
使用过期或无效的访问令牌请求业务接口,将返回未授权或授权无效(HTTP 401),若用户在贝锐平台修改其安全验证信息,包括但不限于:密码、绑定的手机、邮箱、微信等

刷新令牌#

刷新令牌(RefreshToken),一般 AccessToken 的有效时间都较短,AccessToken 过期后调用者可以通过 RefreshToken 进行续约操作,避免需要再次使用用户的实际授权信息或操作(账号密码等)。
刷新令牌一般时效性较长,但它是一次性的,并且与特定的 AccessToken 成对使用。

调用请求#

在需要身份验证的接口中,在 HTTP 验证头中附带 AccessToken,例:

客户端实现#

1.
客户端获取用户身份授权后保存授权数据(AccessToken、RefreshToken)
2.
客户端(调用方)每次发起业务 API 的请求(需要授权的)检查 AccessToken 的过期时间(可以预留一定的时差阈值)
3.
未过期直接发起请求即可,若过期后通过 续租授权 接口,获取新的授权
4.
续租授权 成功返回新的授权后,替换本地保存的授权信息,并使用新的 AccessToken 发起请求
5.
刷新 API 返回 401,表示用户身份授权已失效,需要用户重新进行身份授权(登录)操作

相关 API#

获取用户授权以及令牌刷新(续约)的 API 可参见:用户身份授权API
上一页
平台签名校验
下一页
错误码对照表
Built with