ODK API Portal
ODK Media 서비스들의 API 문서입니다. 서비스를 고르고, 환경을 고르고, 문서에서 바로 호출해 볼 수 있습니다.
처음이라면
-
서비스를 고른다
아래 카드에서 자기 일과 관련 있는 API를 찾습니다. 어느 앱이 쓰는지, 누구를 위한 것인지 적혀 있습니다.
-
환경을 고른다
문서 오른쪽 위 선택기에서 환경을 바꿉니다. prod 는 실제 서비스, staging 은 배포 전 확인용입니다. staging 문서에는 prod 와 다른 지점이 표시됩니다.
-
바로 호출해 본다
엔드포인트의 Test 버튼을 누르면 헤더와 파라미터가 미리 채워진 요청 화면이 열립니다. Send 를 누르면 실제 응답이 옵니다.
MediaIO
Continue Watching
Player Event
지원 종료
문서 위 배지가 뜻하는 것
- 손으로 쓴 스펙입니다 — 서비스 코드에서 생성한 것이 아니라 사람이 관리하는 문서입니다. 실제 동작과 다를 수 있습니다.
- 더 이상 권장하지 않는 버전입니다 — 새 연동에는 쓰지 마십시오. 기존 연동을 위해 남겨둔 문서입니다.
- prod 와 다릅니다 / 아직 prod 에 없습니다 — staging 문서에서 prod 와 갈라진 지점입니다.
용어
| 용어 | 뜻 |
|---|---|
| prod | 실제 사용자가 쓰는 서비스 환경 |
| staging | 배포 전 확인용 환경. 서비스마다 하나 이상 있을 수 있습니다 |
Service-Name | v4 요청 헤더. amasian 또는 lg-channel-vietnam. 어느 서비스의 콘텐츠를 받을지 정합니다 |
did | 기기 식별자 헤더. 즐겨찾기·이어보기처럼 기기별 응답에 필요합니다 |
| 이전 버전 / 지원 종료 | 더 새 버전이 있음 / 기존 연동 유지용으로만 남김 |
대부분의 스펙은 서비스 코드에서 자동 수집됩니다. 어긋난 부분이 보이면 해당 서비스의 코드(extend_schema)를 고쳐야 합니다. 일부 스펙은 odx-api-docs 에서 옮겨온 손으로 쓴 문서이고, 코드 생성으로 옮겨가기 전까지 배지로 표시됩니다.
- 스냅샷과 변경 이력: github.com/odkmedia/api-portal/tree/main/snapshots
- 문제 신고: #backend-api
Last modified on