개요
API를 사용하려면 API 키가 필요합니다.
API 키
API를 사용하려면 먼저 API 키를 발급받아야 합니다.
API 키 사용
모든 API 요청에 X-API-Key 헤더를 포함하세요.
X-API-Key: your_api_key_here⚠️ 보안 주의: API 키는 절대 클라이언트 코드에 노출하지 마세요. 서버 사이드에서만 사용하세요.
HTTP 상태 코드
API 응답의 성공/실패 여부는 HTTP 상태 코드로 판단합니다. 모든 API는 일관된 오류 응답 형식을 사용합니다.
오류 응답 형식
오류 발생 시 다음과 같은 JSON 형식으로 응답합니다.
{
"error": "Error message here",
"details": "Additional details (optional)"
}- •
error: 오류에 대한 간략한 설명 - •
details: 추가적인 오류 상세 정보 (선택적)
상태 코드 목록
| 코드 | 의미 | 설명 |
|---|---|---|
200 | OK | 요청이 성공적으로 처리됨 |
400 | Bad Request | 필수 파라미터 누락 또는 잘못된 형식 |
401 | Unauthorized | API 키가 유효하지 않거나 누락됨 |
403 | Forbidden | 해당 리소스에 대한 접근 권한 없음 |
404 | Not Found | 요청한 리소스를 찾을 수 없음 |
405 | Method Not Allowed | 허용되지 않은 HTTP 메서드 |
429 | Too Many Requests | 요청 한도 초과 (Rate Limit) |
500 | Internal Server Error | 서버 내부 오류 |
503 | Service Unavailable | 서비스를 일시적으로 사용할 수 없음 |