본문으로 이동

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 et status. 보기 WebSocket 프로토콜 전체 워크플로우를 위해.

콘텐츠 유형​

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

알려지지 않은 열쇠들​

알 수 없는 키는 아무런 오류 메시지 없이 무시됩니다.

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