공통 사항

Open API(/open/v1/**)를 호출할 때 공통적으로 적용되는 사항입니다.

Base URL

https://[your-base-url]

인증

Open API(/open/v1/**)는 헤더 Authorization에 Bearer 토큰 형식으로 인증합니다.

Authorization: Bearer {발급된 API Key}

API Key 발급 방법은 API Key 발급 문서를 참고하세요.

응답 래퍼

모든 응답은 공통 ResponseBody 포맷으로 감싸져 내려갑니다.

{
  "code": "SUCCESS",
  "message": "OK",
  "data": { ... },
  "traceId": "00-xxxxx-xxxxx-01"
}

에러 응답

에러 응답에도 동일한 래퍼가 사용되며 code, message, traceId가 포함됩니다. 문의 시 traceId를 함께 공유해 주시면 빠른 추적이 가능합니다.

OpenAPI 문서