API 지원 및 외부 연동

API 지원 (API Support)

BATCAM FX2는 외부 시스템 연동과 자동화를 위해 두 가지 인터페이스를 제공합니다. 실시간 음향·영상 데이터는 WebSocket으로 스트리밍되며, 장비 설정·조회·제어는 REST API를 통해 수행합니다.

구분	용도	통신 방식
WebSocket	실시간 데이터 스트리밍 (음향 데이터, 메타데이터, 장비 상태)	서버 → 클라이언트 실시간 전송 (Protobuf)
REST API	장비 설정·조회·제어, 이벤트 및 데이터 접근	요청-응답 (HTTP)

WebSocket은 장비가 데이터를 지속적으로 발행(push)하는 채널로, 실시간 음향 결과와 상태 정보를 낮은 지연으로 수신할 때 사용합니다. REST API는 사용자가 필요할 때 요청을 보내 설정을 변경하거나 저장된 데이터를 조회하는 데 사용합니다.

BATCAM FX2는 표준 Swagger / OpenAPI 기반 REST API 명세서를 제공합니다. 별도 문서를 참조하지 않아도, 장비에 내장된 문서 페이지에서 전체 API 목록과 각 항목의 파라미터·응답 형식을 확인할 수 있습니다.

http://{device-ip}/api-docs

{device-ip} 자리에 실제 장비의 IP 주소를 입력하여 접속합니다. (예: http://192.168.0.80/api-docs)

표준 규격 준수 — Swagger / OpenAPI 규격을 따르므로 다양한 개발 도구 및 자동 코드 생성기와 호환됩니다.
문서와 테스트 통합 — 명세서 페이지에서 각 API의 설명을 확인하는 동시에, 브라우저상에서 직접 요청을 전송하여 응답을 테스트하고 검증할 수 있습니다.
설치 불필요 — 웹 브라우저만으로 접근 가능하며, 별도의 프로그램 설치가 필요하지 않습니다.