표준오류 메시지

도매꾹 Open API는 오류가 발생할 경우, API의 종류에 관계없이 항상 동일한 형식의 표준오류 메시지를 반환합니다.

메시지 형식

표준오류 메시지는 API 요청 파라미터에서 입력한 설정에 따라 XML 또는 JSON 형식으로 반환됩니다. 표준오류 메시지는 오류코드(code), 오류내용(message), 상세코드(dcode), 상세내용(dmessage)의 4개의 요소로 구성됩니다.


<?xml version="1.0" encoding="ISO-8859-1"?>
<errors>
	<code>20</code>
	<message>API 인증 실패</message>
	<dcode>NOT_REGISTED_KEY</dcode>
	<dmessage>등록되지 않은 API KEY 입니다</dmessage>
</errors>


{
	"errors": {
		"code": "20",
		"message": "API \uc778\uc99d \uc2e4\ud328",
		"dcode": "NOT_REGISTED_KEY",
		"dmessage": "\ub4f1\ub85d\ub418\uc9c0 \uc54a\uc740 API KEY \uc785\ub2c8\ub2e4"
	}
}

일반적으로 오류 메시지는 호출한 API의 종류에 따라 달라지지만, 이하에 기재된 오류 메시지는 모든 API에서 공통적으로 사용합니다.

오류코드(code) 오류내용(message) 상세내용(dmessage) 발생원인 대처방법
1 서버 접근이 금지되었습니다 2019-08-24 18:00:00 ~ 2019-08-25 18:00:00 서버 점검을 진행하고 있습니다. 상세내용(dmessage)에 기재된 시간이 지난 후에 API를 호출해주세요.
10 올바른 요청이 아닙니다 파라미터 에러 요청 파라미터 중에서 필수 값이 누락되지 않았는지, 입력한 값의 자료형은 정확한지 확인하세요.
20 API 인증 실패 등록되지 않은 API KEY 입니다. API 키를 발급하고, 발급받은 요청 파라미터 aid에 정확하게 입력해주세요.
30 API 호출 실패 서비스 접근 거부 HTTPS 프로토콜로 접근해주세요.
31 DB 호출 실패 서비스 접근 거부 현재 API 데이터베이스가 불안정한 상태입니다. 조금 시간이 지난 후에 호출해주세요.
401 권한이 없습니다. 이 요청은 인증이 필요함 별도의 제휴 및 사용허가가 필요한 API입니다.
404 알 수 없는 서비스입니다. 해당 오픈 API 서비스가 없음 요청 파라미터에서 mode와 ver 값이 정확한지 확인하세요.

HTTP 상태오류

도매꾹 Open API를 호출했을 때, 드물게 HTTP 상태코드 중 400번대 또는 500번대 코드가 반환되는 경우가 있습니다. 이 경우에는 Open API의 접근 자체에 문제가 발생한 경우입니다. 주요한 오류는 아래와 같습니다.

HTTP 응답코드 발생원인 대처방법
404 Not Found API 호출 URL이 잘못된 경우 URL을 다시 한 번 확인하여 정확한 URL로 호출합니다.
429 Too Many Requests API 호출 허용량을 초과한 경우 분당 180회 이상 접속한 경우 차단 후 3분, 하루 15,000회 이상 접속한 경우 당일 자정까지 API를 사용할 수 없습니다.