Openclaw ๋๊ธฐํ API (Openclaw Sync API)
๊ฐ์
Openclaw ๋๊ธฐํ API๋ ๋ก์ปฌ Openclaw ์ธ์คํด์ค์ GIIP ํ๋ซํผ ๊ฐ์ ์๋ฐฉํฅ ๋ฐ์ดํฐ(์ค์ ๋ฐ ๋ฌธ์) ๋๊ธฐํ๋ฅผ ์ง์ํ๋ ์๋ํฌ์ธํธ์
๋๋ค. giipAgentWin์ด๋ ๋ค๋ฅธ ๋ก์ปฌ ์์ด์ ํธ๊ฐ ์ฃผ๊ธฐ์ ์ผ๋ก ํธ์ถํ์ฌ ์ต์ ์ค์ ์ ๋ฐ์์ค๊ณ , ๋ก์ปฌ์ ๋ณ๊ฒฝ์ฌํญ์ ์ค์ ์๋ฒ์ ๋ณด๊ณ ํฉ๋๋ค.
๋น ๋ฅธ ์์
์ด API๋ฅผ ์ฌ์ฉํ๋ ค๋ฉด, Agent Token (at)๊ณผ ๋ก์ปฌ ์๋ฒ ์๋ณ์ (lssn)๊ฐ ํ์ํฉ๋๋ค. ๋๊ธฐํ ํ๋ก์ธ์ค๋ ๋ ๋จ๊ณ๋ก ์ด๋ฃจ์ด์ง๋๋ค.
GetOpenclawSync๋ฅผ ํตํด ์ต์ ํด์์ ๋ฐ์ดํฐ๋ฅผ ๊ฒ์ฆ/์์PutOpenclawSync๋ฅผ ํตํด ๋ก์ปฌ์ ๋ณ๊ฒฝ์ฌํญ์ GIIP ์๋ฒ๋ก ์ ๋ก๋
์์ธ ๊ธฐ๋ฅ ๋ฐ API
1. ๋๊ธฐํ ๋ฐ์ดํฐ ์กฐํ (GetOpenclawSync)
๋ก์ปฌ ์ธ์คํด์ค์ Hash ๊ฐ์ ์ ๋ฌํ์ฌ GIIP ์๋ฒ์ ๋ฐ์ดํฐ์ ๋น๊ต ํ ํ์ํ ๊ฒฝ์ฐ ์ต์ ๋๊ธฐํ ๋ฐ์ดํฐ๋ฅผ ๋ฐํํฉ๋๋ค.
- URL:
https://api.netbako.com/api/GetOpenclawSync - Method:
POST - Content-Type:
application/json
์์ฒญ ํ๋ผ๋ฏธํฐ (Request)
| ํ๋๋ช | ํ์ | ํ์ | ์ค๋ช |
|---|---|---|---|
at | String | Y | Agent Token (์ธ์ฆ์ฉ) |
lssn | Integer | Y | ๋ก์ปฌ ์๋ฒ ์๋ณ์ |
configHash | String | N | ํ์ฌ ๋ก์ปฌ ์ค์ ์ Hash ๊ฐ |
docHash | String | N | ํ์ฌ ๋ก์ปฌ ๋ฌธ์์ Hash ๊ฐ |
์๋ต ํ์ (Response)
Hash ๋ถ์ผ์น๋ก ์ ๋ฐ์ดํธ๊ฐ ํ์ํ ๊ฒฝ์ฐ, ์๋ก์ด Hash ๊ฐ๊ณผ ๋ณ๊ฒฝ๋ ๋ฐ์ดํฐ๋ฅผ ๋ฐํํฉ๋๋ค.
{
"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 | Agent Token |
lssn | Integer | Y | ๋ก์ปฌ ์๋ฒ ์๋ณ์ |
changedConfigs | Object | N | ๋ณ๊ฒฝ๋ ์ค์ ํญ๋ชฉ (Key-Value) |
changedDocs | Array | N | ๋ณ๊ฒฝ๋ ๋ฌธ์ ๋ชฉ๋ก (doc_path, doc_content ํฌํจ) |
์๋ต ํ์ (Response)
์ ๋ฐ์ดํธ์ ์ฑ๊ณตํ๋ฉด ์๋ก ๊ณ์ฐ๋ Hash ๊ฐ์ ๋ฐํํฉ๋๋ค.
{
"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๋ฅผ ํ์ธํ์ฌ ์ ํํ ์์ธ์ ๋ถ์ํด์ผ ํฉ๋๋ค.