Skip to main content

API 레퍼런스

LinkBoard의 모든 기능은 REST API(/api/v1)로 공개되어 있습니다.

URL 구조​

/api/v1/{resource}                           # 목록 조회/생성
/api/v1/{resource}/{id}                      # 단건 조회/수정/삭제
/api/v1/{resource}/{id}/{sub}                # 하위 리소스

# 텔레메트리
/api/v1/devices/{token}/telemetry            # HTTP 수신 (장치 토큰 인증)
/ws/telemetry/{device_id}                    # WebSocket 실시간 스트리밍

# 대시보드 템플릿
/api/v1/dashboard-templates                  # 템플릿 목록
/api/v1/dashboard-templates/{id}/instantiate # 템플릿으로 대시보드 생성

응답 형식​

// 성공 (목록)
{ "data": [...], "total": 100, "page": 1, "size": 20 }

// 성공 (단건)
{ "data": { ... } }

// 오류
{ "error": { "code": "DEVICE_NOT_FOUND", "message": "..." } }

인증​

대상방식
일반 APIAuthorization: Bearer {JWT 토큰}
장치 데이터 수신Authorization: Bearer {장치 토큰} (별도 토큰 타입)
외부 시스템 연동Authorization: Bearer {API 키} — lbk_ 접두
슈퍼관리자 전용 API/api/v1/system/ 접두사

API 키는 로그인 후 설정 페이지에서 발급할 수 있으며, 발급 시 평문 값이 한 번만 노출됩니다.

Swagger / ReDoc​

배포한 자신의 LinkBoard 인스턴스에서 /api/docs(Swagger UI) 또는 /api/redoc으로 전체 API 스펙을 바로 확인할 수 있습니다. 프로덕션 환경에서는 API_DOCS_ENABLED=true로 설정해야 노출됩니다(기본은 비노출).