NBCenter CoAP网关服务器API详解：协议、参数与认证

NBCenter CoAP网关服务器API手册提供了详细的指南来理解和操作NBCenter的CoAP服务。该手册的核心内容包括协议描述、请求参数和认证方式。 **协议描述** 请求URL结构遵循特定格式，`http://domain/api/v3/class?params`，其中： - `domain` 是请求的主机地址和端口，如`127.0.0.1:8080`，用于指定服务器的连接地址。 - `/api/v3` 是版本标识，表明请求的是当前API及其对应的版本。 - `class` 是调用的具体接口，根据文档提供的接口列表进行选择。 - `params` 包含公共请求参数，如`appid`、`timestamp` 和 `sign`，这些参数在每个请求中都必不可少。`appid` 需要在应用管理中获取，`timestamp` 表示请求创建的时间戳，确保时效性，但需要与服务器时间同步，且偏差不超过7200秒。 **请求参数** - **公共请求参数**：`appid`、`timestamp` 和 `sign` 必须包含在URL中。`appid` 用于身份验证，`timestamp` 是一个Unix时间戳，用于请求的有效性校验。 - **URL内参数**：某些接口（如`/devices/:devid`）包含动态参数，需要在实际使用时提供相应的设备ID。 - **POST请求参数**：POST接口的参数需要以JSON格式传输，但公共参数仍需通过URL传递，示例代码有助于理解正确格式。 **认证方式** 采用签名验证机制，通过以下步骤生成`sign`字段： 1. 提取请求方法（如GET、POST、DELETE等），记为M。 2. 提取PATH部分，去除HTTP头和请求参数，如`/api/v3/devices`。 3. 将`appid`、`timestamp` 按照`appid=%dtimestamp=%d`的格式连接，记为C。 4. 使用APPID对应的APPKEY，记为K。 5. 将M、P、C和K拼接并转换为小写，然后计算其MD5哈希值，最后将小写哈希值作为`sign`字段。 以示例来看，如果服务器地址是`127.0.0.1:8080`，APPID为1，APPKEY为`ab4ea089c20e09e13e5962`，开发者在构建请求时需要按照上述规则处理URL和签名生成。 此外，手册还提供了WebSocket实时接口的说明，这允许客户端和服务器之间建立双向通信，这对于需要实时数据交换的应用场景非常有用。通过结合上述信息，开发者可以编写客户端代码来调用API，同时确保安全性和有效性。文档中的代码示例可以帮助读者快速上手并理解如何整合这些技术细节。