Openclaw 同步 API (Openclaw Sync API)
概述
Openclaw 同步 API 提供本地 Openclaw 实例和 GIIP 平台之间的数据(配置和文档)双向同步端点。本地代理(如
giipAgentWin)会定期调用此 API,以获取最新配置或将本地更改报告给中央服务器。
快速入门
要使用此 API,您需要一个代理令牌 (
at) 和本地服务器标识符 (lssn)。同步过程通常分为两步:
- 通过
获取并验证最新哈希和数据。GetOpenclawSync - 通过
将本地更改上传到 GIIP 服务器。PutOpenclawSync
详细功能及 API 参考
1. 获取同步数据 (GetOpenclawSync)
传递本地实例的哈希值以与服务器进行比较。如果存在差异,则返回最新的数据。
- URL:
https://api.netbako.com/api/GetOpenclawSync - Method:
POST - Content-Type:
application/json
请求参数 (Request)
| 字段名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| String | Y | 代理令牌(用于身份验证) |
| Integer | Y | 本地服务器标识符 |
| String | N | 当前本地配置的哈希值 |
| String | N | 当前本地文档的哈希值 |
响应格式 (Response)
如果哈希不匹配需要更新,则返回新的哈希值和更新的数据。
{ "RstVal": 1, "RstMsg": "Update required", "Data": { "newConfigHash": "...", "newDocHash": "...", "configData": { ... }, "docData": [ { "doc_path": "...", "doc_content": "..." } ] } }
如果没有更改,则返回 HTTP 200 状态及
RstVal: 304。
2. 上传同步数据 (PutOpenclawSync)
将在本地更改的配置或文档上传到 GIIP 服务器进行同步。
- URL:
https://api.netbako.com/api/PutOpenclawSync - Method:
PUT - Content-Type:
application/json
请求参数 (Request)
| 字段名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| String | Y | 代理令牌 |
| Integer | Y | 本地服务器标识符 |
| Object | N | 更改的配置项 (Key-Value) |
| Array | N | 更改的文档列表(包含 和 ) |
响应格式 (Response)
成功更新后返回新计算的哈希值。
{ "RstVal": 1, "RstMsg": "Successfully updated", "Data": { "newConfigHash": "...", "newDocHash": "..." } }
故障排除
API 调用期间可能出现的常见问题及其解决方法。
- RstVal: -1 (Unauthorized):
令牌无效。请检查令牌是否正确或重新获取。at - RstVal: 400 (Invalid Parameter): 缺少必填参数(
,at
)。请检查 JSON 请求格式。lssn - RstVal: 500 (Internal Server Error): 数据库通信错误或 SP 执行错误。请查看
以分析确切原因。tErrorLogs