Openclaw 同期API (Openclaw Sync API)

概要

Openclaw 同期APIは、ローカルの Openclaw インスタンスと GIIP プラットフォーム間の双方向データ（設定およびドキュメント）同期をサポートするエンドポイントです。giipAgentWin などのローカルエージェントが定期的に呼び出して最新の設定を受信し、ローカルの変更を中央サーバーに報告します。

クイックスタート

このAPIを使用するには、エージェントトークン（at）とローカルサーバー識別子（lssn）が必要です。同期プロセスは以下の2つのステップで行われます。

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): DB通信エラー、またはSP実行エラーです。tErrorLogs を確認して原因を分析してください。

← Previousプロジェクトとユーザー管理API Back to Overviewナレッジセンター