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

平台签名校验

本文为您介绍了如何生成请求签名。
对于每一次HTTPS(HTTP、Websocket)协议 的请求,我们会根据访问中的签名信息验证访问请求者身份。具体由使用 APP Key和 APP Secret对称加密验证实现。其中 APP Key是 获取访问授权的身份,APP Secret是加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密谨防泄露。

请求规范#

1.
所有URL参数必须按照RFC3986规范进行URLEncode,其中空格同时支持%20和+,不同开发语言的用户基本可使用普遍的URLEncode实现
2.
包含Body的请求,请求头必须指定正确的Content-Type和Content-Length
3.
为防止重放攻击,请求包含一个随机串(见下一节),用户必须保证同一个应用(APP Key)在 4小时内的唯一性,否则请求将被拒绝(HTTP 403)

步骤一:构造请求头#

通过 HTTP头提交公共签名参数,参数见下表:
HTTP Header说明
X-OPA-APP-KEYAPP Key,在PaaS平台创建应用获得
X-OPA-TIMESTAMP客户端当前时间戳,与服务器时差必须在24H以内
X-OPA-NONCE随机串,建议使用UUID 或其他可保证唯一的方式处理
X-OPA-SIGN-METHOD签名方法,目前支持 hmac-sha1(缺省), hmac-sha256, hmac-sha521

步骤二:构造待签名字符串#

请求签名为请求信息通过签名算法(HTTP头指定)以及APP Secret运算得到。下面步骤为构造请求签名原文的方法:
假设相关数据如下:
把URL参数的键按本地字序升序排列,构造出如下字符串SortedQueryString:
然后按照以下结构构造待签名字符串(去除拼接符+)
结果为:

步骤三:签名并附加参数#

把步骤二的结果与APP Secret通过指定的签名方法获得请求的签名。
把上面结果通过参数名_signature附加到URL参数中,得到完整的请求如下(注意对签名结果的URLEncode):

示例代码#

以下提供完整的请求示例PHP代码以作参考
以下提供完整的请求示例Python代码以作参考
上一页
接入准备
下一页
用户身份校验
Built with