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

获取客户端API访问凭证

POST
https://openapi.sunlogin.oray.com/keyguard/authorization_code
在调用向日葵客户端API前,您必须先使用该服务端API获取访问凭证
什么是访问凭证#
访问凭证(code)是由向日葵平台颁发的,用来校验调用者身份信息,确保调用者拥有要执行的操作的权限。
参见:接口返回响应code
如何使用访问凭证#
要调用客户端提供的开放能力,请将获取到的访问令牌作为Bearer令牌附加到HTTP请求中的Authorization标头中。例如:
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi.sunlogin.oray.com/keyguard/authorization_code' \
--header 'Content-Md5: 5c675c57cdc14da5ce77d90322ab78e2' \
--header 'X-Ca-Api-Key: YkZzaExwb0lnJDNmOTNhNzBi' \
--header 'X-Ca-Timestamp: 1708426191' \
--header 'X-Ca-Nonce: c9f15cbf-f4ac-4a6c-b54d-f51abf4b5b44' \
--header 'X-Ca-Signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "method": "GET",
  "path": "/get_deviceinfo"
}'
响应示例响应示例
成功示例
{
  "code": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXRob2QiOiJHRVQiLCJwYXRoIjoiL3JlbW90ZXMiLCJlbnRpZCI6MTcsInVzZXJpZCI6MTIzLCJmdW5jIjpbInVzZXJfYWRkIiwidXNlcl9lZGl0Il0sImlzcyI6Ik9yYXkvU3VubG9naW4iLCJleHAiOjE3MDg0MDY5OTUsImp0aSI6ImZkNGY5OWMzLTAxMjktNGRjYi1iOTEyLWJkODQ0YWE5ZGVlZiJ9.30f-uG50XYWDplkegWnKKgiKnTAuIqW_70UiNGjE810",
  "aes_key": "jDLt9vv4i8u3DVjq",
  "expire_time": 1708240320
}

请求参数

Header 参数
Content-Md5
string 
必需
当前请求体参数的MD5摘要
如:MD5({"method": "GET","path": "/get_deviceinfo"})
示例值:
5c675c57cdc14da5ce77d90322ab78e2
X-Ca-Api-Key
string 
必需
参见【系统管理】-【API集成】-【API KEY】
示例值:
YkZzaExwb0lnJDNmOTNhNzBi
X-Ca-Timestamp
integer 
必需
当前时间戳,秒级(与北京时间误差不可超过5分钟)
示例值:
1708426191
X-Ca-Nonce
string 
随机字符串
必需
示例值:
c9f15cbf-f4ac-4a6c-b54d-f51abf4b5b44
X-Ca-Signature
string 
必需
当前请求签名,简单概括为
BASE64(HMAC_SHA256("Content-Md5\nX-Ca-Timestamp\nX-Ca-Nonce\n", ApiSecret))
请参考:服务端API/开发指南/如何调用服务端API/接口签名算法
Body 参数application/json
method
string 
Method
必需
需要访问的客户端API Method
path
string 
Path
必需
需要访问的客户端API Path
示例

返回响应

🟢200成功
application/json
Body
code
string 
访问凭证
必需
只可使用一次,60秒到期
aes_key
string 
随机密钥
必需
expire_time
integer 
过期时间
必需
时间戳(单位秒)
上一页
服务端API错误码对照表
下一页
如何调用客户端API
Built with