API는 기존 HTTP 응답 코드를 사용하여 API 요청의 결과를 나타냅니다. 2xx 범위의 코드는 성공을 나타내고, 4xx 범주는 제공된 정보의 오류 혹은 액세스 제한을 나타내며 5xx 코드는 서버에 오류가 있음을 나타냅니다.
API 오류 메시지는 헤더에 JSON 형식과 HTTP 상태로 반환됩니다. JSON 형식은 에러 코드, 에러 타입, 에러 상세 설명으로 반환됩니다.
| Code | Type | Description |
|---|
40001 | Invalid Body Parameters | The entries provided as body parameters were not valid for the request. |
40002 | Invalid Query Parameters | The entries provided as query parameters were not valid for the request. |
40003 | Missing Required Body Parameters | The request is missing some required body parameters. |
40004 | Missing Required Query Parameters | The request is missing the required query parameters. |
40005 | Rule Violation | The request violated some logic requirement. |
40006 | Missing Required Header Parameters | The request is missing some required header parameters. |
40007 | Invalid Path Parameters | The entries provided as path parameters were not valid for the request. |
| Code | Type | Description |
|---|
401001 | Invalid Key | The method requires authentication, but it was not presented or is invalid. |
| Code | Type | Description |
|---|
403001 | Access Denied | The authentication token in use is restricted and cannot access the requested resource. |
403002 | Account Limit | The plan limit for a resource has been reached. |
403003 | Forbidden Action | The plan is restricted and cannot perform this action. |
| Code | Type | Description |
|---|
404001 | Not Found | A resource id was not found. |
| Code | Type | Description |
|---|
500001 | Unknown | Possibly a temporary issue due to downtime. Wait and retry the operation. |
!!! 내용 완료 개발팀 확인 필요.
