API Reference
엔드포인트, 헤더, 파라미터, 요청/응답, 오류 코드를 제공합니다.
공통 규칙
| 항목 | 규칙 |
|---|---|
| 인증 헤더 | X-API-Key (/api/* 필수) |
| 요청 형식 | Content-Type: application/json |
| 응답 형식 | application/json |
| 권장 헤더 | Accept: application/json |
기능별 API 목차
| 카테고리 | API | Method / Path | 문서 | 구현 상태 |
|---|---|---|---|---|
| 시스템 | 연결/상태 점검 |
GET /healthGET /api/statusGET /api/pingPOST /api/ping
|
시스템 연결 API | 운영 중 |
| 방송 | 방송하기 | POST /broadcasts |
방송하기 API | 예정 |
| 방송 | 방송 목록 | GET /broadcasts |
방송 목록 API | 예정 |
| 방송 | 방송 참여 | POST /broadcasts/{broadcastId}/join |
방송 참여 API | 예정 |
| 방송 | 방송 종료 |
POST /broadcasts/{broadcastId}/endPOST /broadcasts/{broadcastId}/force-end
|
방송 종료 API | 예정 |
| 에셋 | 프로필/스티커 준비 | N/A (정적 리소스 가이드) |
미디어 에셋 준비 가이드 | 운영 중 |
운영 원칙
- 운영 중 API는 실제 서버 동작과 동일하게 유지합니다.
- 예정 API는 PRDS 합의 내용 기준으로 먼저 공개합니다.
- 개발 완료 시 상태를 운영 중으로 즉시 변경합니다.