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

如何调用服务端API

在调用服务端API之前,您需要仔细阅读接入指南,拿到相关的ApiKey之后,再使用特定的步骤计算接口调用签名,用于校验调用者的真实身份信息。

服务端API#

API主机#

环境主机地址
SaaS环境https://openapi.sunlogin.oray.com
私有化环境由于私有化部署差异,请联系客服经理获取适用于您当前私有化环境的API主机地址

固定参数#

服务端API,需要传递以下固定header参数:
参数名参数说明
Content-Md5当前请求体参数的MD5摘要
X-Ca-Api-Key参见【系统管理】-【API集成】-【API KEY】
X-Ca-Timestamp当前时间戳,秒级(与北京时间误差不可超过5分钟)
X-Ca-Nonce随机字符串
X-Ca-Signature当前请求的签名字符串,计算方法详见:《签名计算方法》

签名计算方法#

要计算当前请求的签名字符串(X-Ca-Signature),在发起HTTP请求前,您需要准备以下相关参数

签名计算所需参数#

参数名示例值说明
Content-Md543ae24af5bb530225da6bd0a46508ba8当前请求体参数的MD5摘要, 如:MD5({"method":"GET","path":"/device_info"})
X-Ca-Timestamp1708426191当前时间戳,秒级(与北京时间误差不可超过5分钟)
X-Ca-Noncec9f15cbf-f4ac-4a6c-b54d-f51abf4b5b44生成的随机字符串
ApiSecretNmJiN2Y2MWMtYjgyNy00M2IzLWI2YWUtZTQ1NGMyZGY2MjRj参见【系统管理】-【API集成】-【API KEY】

签名计算过程#

1, 按上述表格所示,准备计算签名所需要的相关参数备用。
2, 将Content-Md5,X-Ca-Timestamp,X-Ca-Nonce按照指定格式拼接字符串
3, 使用ApiSecret作为密钥,对拼接字符串进行HmacSHA256签名计算
4,对HmacSHA256签名结果进行标准BASE64转码,得到最终签名结果
5, 以上步骤,可简单概括为

注意事项#

1,上述签名过程中出现的代码均为伪代码,实际实现时请以您使用的语言为准。
2,为了防止ApiSecret泄漏,计算签名以及服务端API的调用过程应该在您的服务器上完成,不要在客户端进行计算。

示例代码#

为方便理解,下列示例代码演示服务端API的调用过程(使用Go语言实现)请根据业务需要自行处理。
如需完整业务流程的示例代码,可参阅:参考/示例代码
上一页
接入指南
下一页
服务端API错误码对照表
Built with