Openclaw 同步 API (Openclaw Sync API)

概述

Openclaw 同步 API 提供本地 Openclaw 實例和 GIIP 平台之間的數據（配置和文檔）雙向同步端點。本地代理（如

giipAgentWin

）會定期調用此 API，以獲取最新配置或將本地更改報告給中央服務器。

快速入門

要使用此 API，您需要一個代理令牌 (

at

) 和本地服務器標識符 (

lssn

)。同步過程通常分為兩步：

通過
```
GetOpenclawSync
```
獲取並驗證最新哈希和數據。
通過
```
PutOpenclawSync
```
將本地更改上傳到 GIIP 服務器。

詳細功能及 API 參考

1. 獲取同步數據 (GetOpenclawSync)

傳遞本地實例的哈希值以與服務器進行比較。如果存在差異，則返回最新的數據。

URL:

https://api.netbako.com/api/GetOpenclawSync

Method:
```
POST
```
Content-Type:
```
application/json
```

請求參數 (Request)

字段名	類型	必填	描述
`at`	String	Y	代理令牌（用於身份驗證）
`lssn`	Integer	Y	本地服務器標識符
`configHash`	String	N	當前本地配置的哈希值
`docHash`	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)

字段名	類型	必填	描述
`at`	String	Y	代理令牌
`lssn`	Integer	Y	本地服務器標識符
`changedConfigs`	Object	N	更改的配置項 (Key-Value)
`changedDocs`	Array	N	更改的文檔列表（包含 `doc_path` 和 `doc_content` ）

響應格式 (Response)

成功更新後返回新計算的哈希值。

{
  "RstVal": 1,
  "RstMsg": "Successfully updated",
  "Data": {
    "newConfigHash": "...",
    "newDocHash": "..."
  }
}

故障排除

API 調用期間可能出現的常見問題及其解決方法。

RstVal: -1 (Unauthorized):
```
at
```
令牌無效。請檢查令牌是否正確或重新獲取。
RstVal: 400 (Invalid Parameter): 缺少必填參數（
```
at
```
,
```
lssn
```
）。請檢查 JSON 請求格式。
RstVal: 500 (Internal Server Error): 數據庫通信錯誤或 SP 執行錯誤。請查看
```
tErrorLogs
```
以分析確切原因。