# API操作调试示例

在开始下面的步骤之前,请先确认自己在设备管理平台的账号开通了API使用权限。如页面提示暂无权限,请与商务部门联系,申请开通相关服务。

API

API

# 1. 生成签名

1.1 构造认证参数字符串

认证参数字符串由三个部分组成,分别是公钥PubKey、发起调用时的时间戳TS、签名有效期TTL。

  • 获取公钥

登录设备管理平台,点击左上角的头像图标,选择“API”,在弹出的模态框中即可查询到自己的公钥。

API

  • 获取时间戳

请访问此网站 (opens new window),点击页面中“现在”右侧的10位数字,再选择下方“时间戳”右侧的第一个输入框,复制框中所有内容,即为时间戳TS。

注意:时间戳TS的单位为秒,复制时间戳时请确保单位和数字位数均正确。

API

  • 设置签名有效期

为了调试方便,签名有效期TTL可设置为1800秒(30分钟),即签名在生成后的1800秒内都是有效的。后续调试过程中如果API接口返回签名已过期,则需要重新生成签名。

  • 拼接认证参数字符串

仿照下面的示例,将三个认证参数拼接好,复制粘贴至空白的记事本上,备用。

PubKey=72ffc453b6184cdfaf61ef1820858bcd&TS=1637647655&TTL=1800

API

1.2 用私钥对认证参数字符串加密

我们需要使用HMAC-SHA1方式,用私钥对认证参数字符串进行加密,并用Base64进行编码。

打开在线计算工具 (opens new window),在“消息”中填写上一步我们在记事本中做好的认证参数字符串,算法选择“sha1”,密钥填写从设备管理平台用户API界面中获取的私钥,下方两个选项不勾选。

API

API

点击“计算”,结果B即为使用私钥加密后用Base64进行编码的结果。我们将结果B中的所有内容也复制粘贴至记事本,备用。

1.3 生成最终的签名字符串SIG

打开URLEncode在线编码工具 (opens new window),将上一步得到的结果(在线计算工具返回的结果B)复制到输入框中。

API

点击下方的“UrlEncode编码”按钮,输入框中的内容即被替换为URLEncode编码后的结果,这就是我们最终获得的签名字符串SIG。因后续进行API接口调试时将会用到这个签名,故请在签名有效期内妥善保存。

# 2. 调试接口

打开对外开放API在线调试页面 (opens new window),在“设备操作接口汇总”中选择要调试的接口,点击参数列表右上方的“Try it out”进入调试模式。

API

此处以调试查询设备信息接口为例。点击“Try it out”按钮,按照下图说明填写请求参数和请求头参数。

API

点击“Execute”按钮,下方返回正常的JSON格式数据、success显示为true则说明请求成功。

API

如果返回结果中success显示为false,请参照API使用手册 (opens new window)中“API异常返回码”一节的内容进行排查,必要时请联系管理员。