快速入门

特别注意

所有的Api均需要传输Api签名和时间戳，详情请查看签名算法。

开始使用

首先需要在Api-> Api启停 中打开声光播报功能。

设置好Api Key，以便后续使用，默认key为1qaz2wsx。设置方法

Api启停

用来管理Api的启停状态。只有启用的Api才可以成功调用。

签名算法

算法说明

1. 在请求参数数组中加入token项，值为Api Key，加入time项，值为当前的时间戳。之后按照key值进行字典升序排列。
2. 按排列后顺序进行组合，按照key value进行拼接，得到签名字符串sign_str。
3. 将拼接好后的签名字符串sign_str，使用MD5进行散列计算，即可得到签名字符串sign。

计算实例

1. 假设要请求的原始参数如下表

   参数名	值
   led_style	15
   color	["#123456"]
   led_flag	[0.1,1]
   text	好用的声光播报终端
   time	1668843530

2. 参数数组中加入token和time

   注意

   此步骤在请求数组中加入内容，并不是修改真实的请求参数数组，而是为了计算需要所需要的中间步骤！

   参数名	值
   led_style	15
   color	["#123456"]
   led_flag	[0.1,1]
   text	好用的声光播报终端
   time	1668843530
   token	1qaz2wsx

3. 以key按照字典升序排序，之后对字符串进行拼接，得到签名字符串sign_str

   color["#123456"]led_flag[0.1,1]led_style15text好用的声光播报终端time1668843530token1qaz2wsx

4. 对签名上述的字符串进行MD5计算，可以得到签名sign

   dc76013f54527b7074e4076e86fba803

5. 将sign，time添加到请求参数中，得到最终的请求参数

   参数名	值
   led_style	15
   color	["#123456"]
   led_flag	[0.1,1]
   text	好用的声光播报终端
   time	1668843530
   sign	dc76013f54527b7074e4076e86fba803

6. 使用Post方式将其作为请求内容发送即可，请求成功后得到响应值。

    {
        "code": 200,          // 状态码，200表示成功
        "msg": "OK",          // 返回信息，OK表示成功
        "data": {
            "method": 50,     // 方法id，无需处理
            "id": "4972367dd614bf8adfe5fff138a3af76", // 本次请求的id
            "data": 1,        // 设备播报队列中剩余待播报的数量
            "res_code": 0     // 内部状态码，正常为0，无需处理
        }
    }