API 레퍼런스
모든 API 요청의 Base URL은 https://openapi.meloming.com 입니다.
API 카테고리
채널 조회, 검색, 랭킹
채널 API노래 CRUD, 통합 검색, 카테고리, 아티스트
채널 노래책 API채널 프로필 조회 및 수정
채널 프로필 API방송 일정 CRUD
채널 일정 API공모전, 이벤트 등 콘텐츠 정보
콘텐츠 뻐꾸기 API에러 응답 형식 및 코드 목록
에러 코드공통 응답 형식
성공 응답
단일 리소스 조회 시 리소스 객체가 직접 반환됩니다.
Single Resource
{
"id": 1,
"name": "채널명",
...
}페이지네이션 응답
목록 조회 시 페이지네이션 정보가 포함됩니다.
PageResponse<T>
{
items: T[] // 결과 목록
pagination: {
page: number // 현재 페이지
size: number // 페이지 크기
total: number // 전체 결과 수
totalPages: number // 전체 페이지 수
hasNext: boolean // 다음 페이지 존재 여부
hasPrevious: boolean // 이전 페이지 존재 여부
}
}에러 응답
모든 에러 응답은 일관된 형식을 따릅니다.
ErrorResponse
{
meta: {
version: string // API 버전
requestId: string // 요청 ID (문의 시 첨부)
timestamp: string // 응답 시간
}
status: number // HTTP 상태 코드
type: string // 에러 타입
message: string // 에러 메시지
errors?: {...}[] // 상세 오류 (Validation 에러 시)
}자세한 에러 코드 목록은 에러 코드 페이지를 참조하세요.
인증
| 인증 방식 | 용도 | 헤더 |
|---|---|---|
| 없음 | 공개 GET 요청 | - |
| API Key | Rate Limit 상향 | X-API-Key: YOUR_API_KEY |
| OAuth 2.0 | 채널/콘텐츠 관리 (쓰기 작업) | Authorization: Bearer ACCESS_TOKEN |
자세한 내용은 인증 가이드를 참조하세요.
Last updated on