오류
이 가이드에서는 API를 사용하는 동안 문제가 발생할 때 어떤 일이 일어나는지 알아봅니다. API 사용 시 다양한 이유로 문제가 발생할 수 있으며, API 호출 과정에서 발생하는 대부분의 오류는 쉽게 해결할 수 있습니다. 여러분이 마주할 수 있는 상태 코드와 오류 유형에 대해 알아보겠습니다.
API 응답을 받을 때 상태 코드를 확인하여 요청이 성공했는지 알 수 있습니다. 응답이 실패한 경우, 오류 유형과 오류 메시지를 통해 문제의 원인을 파악하고 기본적인 디버깅을 수행할 수 있습니다.
지원팀에 문의하기 전에 코드와 요청 형식을 검토해 보시기 바랍니다. 대부분의 오류는 API 문서를 참고하여 쉽게 해결할 수 있습니다.
상태 코드
다음은 APoT API가 반환하는 다양한 범주의 상태 코드 목록입니다. 이를 통해 요청이 성공했는지 확인할 수 있습니다.
- Name
2xx- Description
2xx 상태 코드는 성공적인 응답을 나타냅니다.
- Name
4xx- Description
4xx 상태 코드는 클라이언트 측 오류를 나타냅니다 — 요청 형식이나 매개변수 등의 문제일 수 있습니다.
- Name
5xx- Description
5xx 상태 코드는 서버 측 오류를 나타냅니다 — 서비스 운영팀에서 해결해야 하는, 보다 드문 오류입니다.
오류 유형
요청이 실패할 때마다 APoT API는 오류 유형과 메시지가 포함된 오류 응답을 반환합니다. 이 정보를 통해 문제의 원인과 해결 방법을 파악할 수 있습니다. 대부분의 오류 메시지는 구체적이고 도움이 됩니다.
다음은 APoT API에서 지원하는 두 가지 오류 유형 목록입니다. 이를 통해 문제의 성격을 이해할 수 있습니다.
- Name
api_error- Description
서버 측 문제로 인한 오류입니다. 이 경우 문제가 지속되면 지원팀에 문의해 주세요.
- Name
invalid_request- Description
요청 형식이나 매개변수에 문제가 있는 경우입니다. 문서를 참고하여 요청을 수정해 보세요.
오류 응답
{
"type": "api_error",
"message": "서비스 내부 오류가 발생했습니다. 잠시 후 다시 시도해 주세요.",
"documentation_url": "https://apot.io/docs/errors/api_error"
}