开放接口 (OpenAPI) 指南

PieMDM 提供了强大的 OpenAPI，允许外部系统通过安全认证的方式访问主数据。OpenAPI 采用了基于规范请求（Canonical Request）的 HMAC-SHA256 签名机制，确保请求的真实性和完整性。

1. 认证机制

所有 OpenAPI 请求必须在 Header 中携带以下认证参数：

签名的计算过程如下：

构造规范请求字符串 (Canonical Request)：格式为各部分由换行符 \n 连接：
text
```
HTTPMethod + "\n" +
CanonicalURI + "\n" +
CanonicalQueryString + "\n" +
SHA256(RequestBody) + "\n" +
X-Timestamp + "\n" +
X-Nonce
```
- HTTPMethod: 大写的 HTTP 方法，如 GET 或 POST。
- CanonicalURI: 请求的完整路径，必须以 / 开头，如 /openapi/v1/entities/users。
- CanonicalQueryString: 排序后的查询参数字符串。按参数名 ASCII 升序排列，格式为 key1=value1&key2=value2。
- SHA256(RequestBody): 请求体的 SHA256 哈希值（小写 Hex）。若 Body 为空，则哈希值为：e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855。
- X-Timestamp 和 X-Nonce: 与 Header 中的值保持严格一致。
计算签名：使用应用的 AppSecret 作为 Key，对上述规范字符串进行 HMAC-SHA256 计算：
text
```
Signature = Hex(HMAC-SHA256(AppSecret, CanonicalRequest))
```

除了签名验证，OpenAPI 还提供了多重安全保障：

所有接口的基础路径为：/openapi/v1

GET /openapi/v1/entities/{table_code}

查询参数：

GET /openapi/v1/entities/{table_code}/{id}