오류 코드/메시지

Cafe24 Analytics API를 호출하는 과정에서 잘못된 방법이나 올바르지 않은 형식으로 이벤트를 전송하거나 서버 측 내부 오류 등의 이유로 서비스를 제공할 수 없을 수 있습니다. 이때 오류 메시지를 클라이언트(API)로 전송합니다.이 문서에서는 발생할 수 있는 오류 코드 및 메시지 형식을 정의합니다.

API 오류 코드

  • 아래 오류 코드는 Http Response Code 로 제공되고 있습니다. 또한, 오류 코드는 계속 추가될 수 있습니다.

오류 코드 기본 양식

오류 코드 기본 양식
Response Class 설명
2xx Success(성공)
4xx Client Error(클라이언트 오류)
5xx Server Error(서버 오류)

5xx 에러가 지속적으로 발생할 경우 카페24 개발자센터로 문의해 주시기 바랍니다.

오류별 대응 방법

  • 오류 코드/ 메시지별 발생 원인과 그에 따른 대응 방법을 안내합니다.
오류별 대응 방법
Status Code 메시지 Header 발생원인 대응방법
200 Success OK GET 성공 -
400 Bad Request Bad Request 요청 URI 자체에 문제가 있음 요청한 값을 재확인하세요.
400 Requested client_id is invalid. Bad Request 알 수 없는 클라이언트일 경우 클라이언트 아이디가 올바른지 확인하세요.
400 Requested client_secret is invalid. Bad Request 유효하지 않은 클라이언트 시크릿일 경우 클라이언트 시크릿이 올바른지 확인하세요.
401 Client ID or Client secret is empty. Unauthorized 클라이언트 아이디 또는 시크릿이 누락된 경우 클라이언트 아이디와 시크릿을 입력하세요.
401 Unauthorized Unauthorized 액세스 토큰이 없는 경우 유효한 액세스 토큰을 사용하였는지 확인하세요.
401 Check the scope. Unauthorized 올바르지 않은 스코프값일 경우 스코프 설정값을 확인하세요.
404 No API found. Not Found - 요청 URI가 잘못되었거나 리소스 경로가 올바르지 않은 경우
-존재하지 않은 버전 요청을 한 경우
API 문서를 참고하여 잘못된 부분이 있는지 확인하세요.
422 Check the search conditions and try again.. Unprocessable Content -필수 파라미터 누락
-정해진 기본값과 불일치/ 올바른 입력값이 아님
API 문서를 참고하여 누락된 파라미터 또는 유효하지 않은 값이 있는지 확인하세요.
429 Too Many Attempt Too many request API 최대 허용 요청 건수 초과 API 최대 허용 요청 건수를 초과하지 않도록 조절하세요.
500 A temporary server error occurs. Internal Server Error 내부 서버 에러/ 알 수 없는 에러 일시적으로 에러가 발생하였습니다. 잠시 후에 다시 시도하세요.
504 Gateway time-out Gateway Timeout 요청 시간이 초과된 경우(Timeout) 일시적인 에러가 발생하여 응답이 지연되는 경우입니다. 잠시 후에 다시 시도하세요.

오류 메시지 구조

  • API 실행 중 에러가 발생한 경우 아래 예시와 같은 형태로 노출됩니다.
{ "error": { "code": 422, "message": "조건을 체크해주세요.(parameter.product_name)", "more_info": [] } }
이 페이지가 얼마나 도움이 되었나요?
도움안됨
도움됨
0자 입력 /최대 300자