API Basics
1. Requirements
모든 API는 호출 시 헤더에 API Key가 필요합니다.
API Key 발급을 받지 않으셨다면, Generate API key 에서 확인할 수 있습니다.
Field | Type | Description |
---|---|---|
x-api-key | String | API Key |
2. Response Structure
모든 API 응답은 다음과 같은 응답 객체 구조로 이루어져 있습니다.
Field | Type | Description |
---|---|---|
detail | String | API 호출 결과에 따른 메시지 값입니다. |
result | Object | API 호출에 따른 결과값입니다. (API 호출 성공시 제공) |
3. Common Error Responses
API 호출 시 발생할 수 있는 공통 에러 응답은 다음과 같습니다.
- 401 Unauthorized
- API Key가 없거나 유효하지 않음
{ "detail": "Unauthorized" }
- 403 Plan is expired
- 플랜 사용 기간이 만료됨
{ "detail": "Plan is expired" }
- 403 Rate limit exceeded
- API 호출 수가 정해진 Rate limit 값을 초과
{ "detail": "Rate limit exceeded" }
- 403 Quota exceeded
- API 호출 수가 정해진 Quota 값을 초과
{ "detail": "Quota exceeded" }
Updated over 1 year ago