menu

응답코드

  • date_range 23/06/2016 00:00 info
    sort
    v1
    api
    label

API 호출을 통해 HTTP의 상태 코드 및 실행 결과에 따른 다양한 에러 코드가 존재합니다.

HTTP 상태 코드

상태 코드 설명 비고
200 성공 Response Body의 경우 각 API별로 틀릴 수 있음
400 실패 일반적인 오류. 주로 API에 필요한 필수 파라미터와 관련
401 실패 인증 오류 (승인되지 않은 사용자)
403 실패 권한/퍼미션등의 오류
500 실패 시스템 오류
503 실패 서비스 점검중(휴가중)

호출 성공의 경우 각각의 API별 응답 바디(Response Body)의 형식이 다를 수 있으므로, 자세한 내용은 각 API별 상세 설명을 참고하세요.

에러 코드

호출 실패시 HTTP 상태 코드외에 JSON 형식의 에러 코드 및 원인을 메시지로 받을 수 있습니다.

상세 코드

다음은 에러 코드에 대한 정의입니다. 값은 모두 음수로 표현됩니다.

code 설명 HTTP 상태 코드
-1 내부 처리 오류. 에러 코드로 상세 분류되어 있지 않은 경우(사람이라 실수) 400
-2 잘못된 파라미터. 호출 인자값이 잘못되었거나 필수 인자가 포함되지 않은 경우 400
-3 지원되지 않는 서비스 API에 대한 호출. 400
-4 인증 관련 제재로 인해 API 호출이 금지된 경우 400
-5 해당 API에 대한 권한/퍼미션이 없는 경우 403

샘플 코드

사용자 인증 오류

{
  "code":-401,
  "msg":"InvalidTokenException"
}

code 값의 경우 특별한 규칙을 가지고 있지 않으며, msg 값의 경우 의미가 바뀌지 않는 범위에서 내용이 바뀔 수 있습니다.