※ 오픈API 사용신청을 하여 발급받은 키와 질의어를 이용하여 요청 URL을 작성하고, 이에 따른 xml형태의 결과를 받습니다.
1.기본 요청 URL(request url) :::::
http://biz.epost.go.kr/KpostPortal/openapi
2.요청변수(request parameter) :::::
우편번호API, 종추적API, EMS종추적API는 다음과 같은 요청 변수를 갖습니다.
우편번호API, 종추적API의 요청 변수
| 요청변수 |
값 |
설명 |
| regkey |
string(필수) |
사용신청을 통해 받은 인증 key 스트링(30자리)
|
| target |
string(필수) |
서비스에 따라 다음과 같이 지정해야 하는 필수 값 입니다.
우편번호API서비스 - post
종추적API 서비스 - trace
EMS종추적API 서비스 - emsTrace(한글), emsEngTrace(영문)
|
| query |
string(필수) |
조회하고자 하는 내용의 검색 질의어입니다.
우편번호API 서비스인 경우는 읍/면/동, 종추적API 서비스인 경우는 등기번호 13자리 입니다.
예) 우편번호API 서비스 - 신사동, 구의1동…
종추적API 서비스 - 1234567890123
EMS종추적API 서비스 - EM123456789KR
|
3.최종 샘플 URL :::::
- 우편번호API 서비스인 경우
- 종추적API 서비스인 경우
- EMS종추적API 서비스인 경우
- 영문 EMS종추적API 서비스인 경우
4.출력결과(response field) :::::
각 서비스API xml 결과는 다음과 같은 item 이름으로 각 값을 확인할 수 있습니다.(테스트URL 결과 참조)
우편번호 API 서비스
| 필드 |
값 |
설명 |
| zipcode |
string |
우편번호 |
| address |
string |
주소 |
종추적 API서비스
| 필드 |
값 |
설명 |
| sendnm |
string |
발송인 |
| recevnm |
string |
수취인 |
| regino |
string |
등기번호 |
| mailtypenm |
string |
우편물종류 |
| mailkindnm |
string |
취급구분 |
| eventymd |
string |
배달결과-날짜 |
| eventnm |
string |
배달결과-상태 |
| signernm |
string |
수령인 |
| relationnm |
string |
수령인관계 |
| sortingdate |
string |
날짜 |
| eventhms |
string |
시간 |
| eventregiponm |
string |
현재위치 |
| tracestatus |
string |
처리현황 |
| delivrsltnm |
string |
상세설명 |
| nondelivreasnnm |
string |
미배달 사유설명 |
EMS 종추적 API서비스
| 필드 |
값 |
설명 |
| sendernm |
string |
발송인 |
| receivernm |
string |
수취인명 |
| regino |
string |
등기번호 |
| mailtypenm |
string |
우편물구분코드명 |
| mailkindnm |
string |
종별구분코드 |
| deliverydate |
string |
배달일자 |
| deliveryyn |
string |
배달완료여부 |
| signernm |
string |
수령인 |
| relationnm |
string |
수취인관계 |
| connectedregino |
string |
연계등기번호 |
| postmannm |
string |
집배원성명 |
| inboundoutboundnm |
string |
국내수출입구분명 |
| recvpostzipcd |
string |
접수우체국우편번호 |
| recvposttelno |
string |
접수우체국전화번호 |
| destcountrycd |
string |
도착국가코드 |
| destcountrynm |
string |
도착국가명 |
| gcdate |
string |
배달보장일자 |
| postimpccd |
string |
우체국IMPC코드 |
| relationnm |
string |
수취인관계 |
| receiverzipcd |
string |
수취인우편번호 |
| customsfailednm |
string |
미통관사유코드명 |
| sendcnt |
string |
발송번호 |
| sendflightno |
string |
발송번호 |
| airdate |
string |
항공기출항일시 |
| deliposttelno |
string |
배달우체국전화번호 |
| sortingdate |
string |
생성일자 |
| eventhms |
string |
이벤트 시간 |
| eventregiponm |
string |
발생우체국명 |
| delivrsltnm |
string |
배달결과설명 |
| nondelivreasnnm |
string |
미배달 사유설명 |
| eventnm |
string |
이벤트 이름 |
| eventymd |
string |
이벤트 날짜 |
| upucd |
string |
UPU 이벤트코드 |
5.에러메세지 :::::
API서비스 이용시 다음과 같은 메세지가 반환이 될 경우 해당 내용에 대해 다시 확인하시기 바랍니다.
에러메세지
| 에러코드 |
에러내용 |
| 001 |
시스템 점검 중 입니다. |
| 002 |
인증 받지 않은 key 입니다. |
| 003 |
유효하지 않은 검색 질의어입니다. |
xml로 메세지가 반환될 경우 다음과 같은 구조를 갖습니다.
1 
518 
0
2010-12-07 18:59:42 
추천
신고