본문으로 건너뛰기

JSON 규약

모든 서비스 인터페이스는 JSON을 사용합니다. 이 페이지에서는 일반적인 패턴에 대해 설명합니다.

포트​

포트인터페이스버전
10001HTTP REST + WebSocket (시뮬레이션 채널)v3.1(현재 버전)
10020WebSocket(이벤트 채널, 읽기 전용)—
10000레거시 WebSocket (v3.0 — v4.0에서 제거 예정)v3.0

HTTP 응답 엔벨로프​

모든 HTTP 응답은 동일한 엔벨로프를 사용합니다:

성공 (데이터 있음):

{ "ok": true, "data": { … } }

성공 (데이터 없음 — 변경 전용 엔드포인트):

{ "ok": true }

오류:

{ "ok": false, "error": "reason string" }

권장되지 않는 엔드포인트:

{ "ok": true, "deprecation_warning": "This route is deprecated. Use …" }

HTTP 상태 코드​

코드의미
200성공
400잘못된 요청 — 본문 무효, 선택자가 모호함, 필수 필드 누락
404장치, 세션 또는 리소스를 찾을 수 없습니다.
405이 메서드는 허용되지 않습니다.

WebSocket 메시지 형식​

메시지는 JSON 객체입니다. 최상위 키는 디바이스 그룹 이름(inverse3、verse_grip、wireless_verse_grip)와 세션 수준 명령어를 위한 옵션인 session 키입니다.

클라이언트 → 서비스(명령):

{
  "session": { "configure": { … } },
  "inverse3": [
    { "device_id": "049D", "configure": { … }, "commands": { … } }
  ]
}

서비스 → 클라이언트(상태):

{
  "session_id": 7,
  "inverse3": [
    { "device_id": "049D", "config": { … }, "state": { … }, "status": { … } }
  ]
}

서비스에서 보내는 첫 번째 메시지에는 config(전체 스냅샷)이 포함되어 있으며, 이후의 메시지에는 state 그리고 status 만 포함됩니다. 전체 워크플로에 대해서는,WebSocket 프로토콜 를 참조하십시오.

콘텐츠 유형​

본문을 포함하는 모든 HTTP 요청은,Content-Type: application/json 을 전송해야 합니다. WebSocket 메시지는 항상 일반 텍스트 형식의 JSON 프레임입니다.

알 수 없는 키​

알 수 없는 키는 아무런 조치 없이 무시됩니다.

현재 이 서비스는 인식되지 않는 JSON 키를 오류 없이 무시합니다. 명령이 제대로 작동하지 않는 것처럼 보인다면, 서비스 로그를 확인하고 필드 이름을 API 참조 문서와 대조해 보십시오. 이 동작은 향후 버전에서 변경될 예정입니다(알 수 없는 키가 발생하면 경고 이벤트가 발생하게 됩니다).