LinkOStar 문서
LinkOStar는 IoT 디바이스의 연결성·셋업·관제를 공유 플랫폼으로 제공하는 서비스입니다. 여러 supplier가 각자의 디바이스/번들을 올리고, 최종 사용자가 hub를 설치해 연결합니다. 이 문서는 LinkOStar를 통합하려는 supplier·BFF·운영 파트너를 위한 단일 진입점입니다.
여기 어떤 정보가 있나
- Live spec — 코드 변경 즉시 반영되는 OpenAPI 정의 (/api-docs) 와 Swagger UI (/swagger-ui/index.html).
- 통합 패턴 — supplier가 자기 백엔드(BFF)에서 LinkOStar를 호출하는 가장 일반적인 흐름 + 권장 사항.
- 인증·envelope·페이지네이션 같은 모든 endpoint에 공통으로 적용되는 규약.
- 데이터 모델·아키텍처 — 어떤 엔티티가 어떻게 묶이는지, 컴포넌트가 어떤 책임을 지는지.
- 변경 이력 — 무엇이 언제 바뀌었고, 호환성을 깨는 변경은 얼마나 미리 알리는지.
여기에 없는 정보
- Supplier별 비즈니스 데이터 — 각자의 API Key · supplier_uuid · BFF 도메인 등. 사용 중인 supplier 조직의 secret manager / 내부 문서에 둡니다.
- 요금/계약 사항 — sdx-billing 측 별도 문서.
- 내부 결정 이력 —
LinkOStarGitHub repo의 SSOT 마크다운에 있지만, 외부 공개 대상이 아닙니다.
각 페이지 안내
통합 가이드
Supplier 또는 BFF로 LinkOStar에 붙는 방법. 호출하는 endpoint, 인증 흐름, SDK 생성까지.
API Reference
Swagger UI · OpenAPI 3.0 spec. 코드 변경 즉시 자동 갱신.
인증
X-API-Key · JWT(sdx-oauth) · X-Tenant-UUID · hub bearer. 어느 경로에 어느 자격이 필요한지.
응답 규약
{ data, pagination } envelope · error shape · status code 컨벤션.
데이터 모델
주요 엔티티 (Tenant · SupplierBundle · HubInstance · ProvisioningRun ...) 와 관계.
아키텍처
hub-agent · backend · web · mobile · supplier BFF 가 어떻게 맞물리는지.
변경 이력
버전 · breaking change 노티스 SLA · 마이그레이션 가이드.
지원
SLA · 컨택 포인트 · 장애 대응.
처음 통합하는 경우
먼저 아키텍처에서 시스템 전체 그림을 확인한 뒤, 인증 → 통합 가이드순서로 따라가면 거의 모든 통합 시나리오를 30분 이내에 시작할 수 있습니다.