Open API
우체국금융 OPEN API
- 핀테크업체 개발자를 위한 우체국금융 OPEN API서비스 입니다.
- 우체국 금융 OPEN API는 금융정보를 누구나 사용할 수 있도록 공개된 API로서 우체국 금융정보를 활용하여 웹서비스 및 어플리케이션 개발을 지원하기 위하여 API를 외부에 공개 합니다.
- 요청에 대한 결과는 xml형태로 제공되며 사용자는 이를 이용하여 원하는 디자인의 형태로 구현하고, 우체국에서 제공하는 금융정보를 활용하실 수 있습니다.
우체국금융API
| API | 소개 |
|---|---|
| 예금상품정보 조회 | 예금 상품명을 이용하여 카드발급여부, 인터넷가입여부 등 우체국금융 예금상품정보를 조회할 수 있는 서비스입니다. |
| 보험상품정보 조회 | 보험 상품명을 이용하여 개인단체여부, 금리연동구분 등 우체국금융 보험상품정보를 조회할 수 있는 서비스입니다. |
| 보험공시이율 조회 | 보험이자율명을 이용하여 우체국금융 보험공시이율을 조회할 수 있는 서비스입니다. |
| 1회 보험료 조회 | 보험 상품, 나이, 성별정보를 이용하여 우체국금융 1회 보험료를 조회할 수 있는 서비스입니다. |
- 우체국금융 OPEN API는 공공데이터포털 (http://www.data.go.kr/)에서 신청하시면 서비스 받으실 수 있습니다.
기본 요청 URL(request url)
- 예금상품정보 조회
http://apis.data.go.kr/1721301/KpostDepositProductView/depositGoods - 보험상품정보 조회
http://apis.data.go.kr/1721301/KpostInsuranceProductView/insuranceGoods - 보험공시이율 조회
http://apis.data.go.kr/1721301/KpostInsuranceInterestRateView/insuranceInterestRate - 1회 보험료 조회
http://apis.data.go.kr/1721301/KpostInsuranceFeeCalculationView/insuranceFee
요청변수(request parameter)
- 예금, 보험상품 API는 다음과 같은 요청 변수를 갖습니다.
| API서비스 | 요청변수 | 값 | 설명 |
|---|---|---|---|
| 예금상품정보 조회 | ServiceKey | string(필수) | 공공데이터포털에서 발급받은 인증키 |
| GOOD_KOR_NM | string(선택) | 검색을 원하는 상품명 입력(미입력: 전체 조회) | |
| 보험상품정보 조회 | ServiceKey | string(필수) | 공공데이터포털에서 발급받은 인증키 |
| GOOD_ABNM | string(선택) | 검색을 원하는 상품명 입력(미입력: 전체 조회) | |
| 보험공시이율 조회 | ServiceKey | string(필수) | 공공데이터포털에서 발급받은 인증키 |
| INSU_INTR_RATE_CODE_NM | string(선택) | 검색을 원하는 이자율명 입력(미입력: 전체 조회) | |
| 1회 보험료 조회 | ServiceKey | string(필수) | 공공데이터포털에서 발급받은 인증키 |
| PRODUCT_NAME | string(필수) | 검색을 원하는 상품명 입력 조회 대상 상품(무배당 에버리치복지보험, 무배당 알찬전환특약, 무배당 그린보너스저축보험, 무배당 파워적립보험) |
|
| JOIN_AGE | string(필수) | 에버리치복지보험: 만 나이를 숫자로 입력, 그외 상품: 0세 이상 입력 | |
| SEX_CODE | string(필수) | M(남성),W(여성) 입력 |
출력항목(response field)
- 예금, 보험상품API는 다음과 같은 출력 변수를 갖습니다.
| API서비스 | 출력항목 | 값 | 설명 |
|---|---|---|---|
| 예금상품정보 조회 | resultCode | string | API 에러코드 |
| resultMsg | string | 에러 메시지 | |
| GOOD_CLSF | string | 상품종류 | |
| GOOD_KOR_NM | string | 상품명 | |
| MAN1_ACC1_ITMS_YN | string | 1인1계좌과목여부 | |
| CARD_ISUE_PSBL_YN | string | 카드발급여부 | |
| INTR_PAY_PSBL_YN | string | 인터넷가입가능여부 | |
| INTR_PAY_KIND | string | 이자지급방법 | |
| ENTR_CUST_DVSN | string | 가입고객구분 | |
| GOOD_TAXT_DVSN | string | 상품과세구분 | |
| REGISTER_MIN | string | 최소가입기간 | |
| REGISTER_MAX | string | 최대가입기간 | |
| 보험상품정보 조회 | resultCode | string | API 에러코드 |
| resultMsg | string | 에러 메시지 | |
| GOOD_ABNM | string | 상품명 | |
| PPSN_ASCT_DVSN | string | 개인단체구분 | |
| RINT_LNKG_DVSN | string | 금리연동구분 | |
| PPAM_DC_YN | string | 선납할인여부 | |
| PINS_MIN | string | 보험기간(MIN) | |
| PINS_MAX | string | 보험기간(MAX) | |
| UNIT_CODE | string | 단위코드 | |
| INTN_ENTR_PSBL_YN | string | 온라인보험여부 | |
| GOOD_CLSF_NM | string | 상품분류 | |
| 보험공시이율 조회 | resultCode | string | API 에러코드 |
| resultMsg | string | 에러 메시지 | |
| INSU_INTR_RATE_CODE_NM | string | 보험이자율명 | |
| APLY_STRT_DATE | string | 적용시작일 | |
| APLY_END_DATE | string | 적용종료일 | |
| NORM_INTR_RATE | string | 정상이자율 | |
| ARIN_RATE | string | 연체이자율 | |
| PPAM_INTR_RATE | string | 선납이자율 | |
| 1회 보험료 조회 | resultCode | string | API 에러코드 |
| resultMsg | string | 에러 메시지 | |
| RECORD_ID | string | 레코드ID | |
| JOIN_AGE | string | 가입나이 | |
| SEX_CODE | string | 성별코드 | |
| INSURANCE_PAYMENT | string | 보험료 | |
| PAYMENT_PERIOD | string | 납입기간 | |
| INSURANCE_PERIOD | string | 보험기간 | |
| JOIN_PAYMENT_STANDARD | string | 가입금액기준 | |
| CONTRACT_DIVISION | string | 계약구분 | |
| CONTRACT_TYPE | string | 계약유형 | |
| PRODUCT_CODE | string | 상품코드 | |
| PRODUCT_NAME | string | 상품명 |
요청URL 및 결과xml 샘플
| API서비스 | 요청URL 및 결과xml 샘플 |
|---|---|
| 예금상품정보 조회 | 상품명이 ‘Smart’를 포함하는 상품 조회 http://apis.data.go.kr/1721301/KpostDepositProductView/depositGoods?serviceKey=인증키&GOOD_KOR_NM=Smart |
| 보험상품정보 조회 | 상품명이 'IN'을 포함하는 상품조회 http://apis.data.go.kr/1721301/KpostInsuranceProductView/insuranceGoods?serviceKey=인증키&GOOD_ABNM=IN |
| 보험공시이율 조회 | 이자율명이 '신공시'를 포함하는 이율 조회 http://apis.data.go.kr/1721301/KpostInsuranceInterestRateView/insuranceInterestRate?serviceKey=인증키&INSU_INTR_RATE_CODE_NM=신공시 |
| 1회 보험료 조회 | 보험명이 '무배당 에버리치복지보험'이고, 가입나이는 만 44세, 여성인 경우 1회 보험료 조회 http://apis.data.go.kr/1721301/KpostInsuranceFeeCalculationView/insuranceFee?serviceKey=인증키&PRODUCT_NAME=무배당 에버리치복지보험&JOIN_AGE=44&SEX_CODE=W |
오류코드 및 샘플
- API서비스 이용시 다음과 같은 메세지가 반환이 될 경우 해당 내용에 대해 다시 확인하시기바랍니다
| 에러코드 | 에러내용 |
|---|---|
| APPLICATION_ERROR | 어플리케이션 에러 |
| INVALID_REQUEST_PARAMETER_ERROR | 잘못된 요청 파라메터 에러 |
| NO_REQUEST_PARAMETER_ERROR | 필수 파라메터 부존재 에러 |
| NO_OPENAPI_SERVICE_ERROR | 해당 오픈API서비스가 없거나 폐기됨 |
| SERVICE_ACCESS_DENIED_ERROR | 서비스 접근거부 |
| LIMITED_NUMBER_OF_SERVICE_REQUESTS_EXCEEDS_ERROR | 서비스 요청제한횟수 초과에러 |
| SERVICE_KEY_IS_NOT_REGISTERED_ERROR | 등록되지 않은 서비스키 |
| DEADLINE_HAS_EXPIRED_ERROR | 기한만료된 서비스키 |
| UNREGISTERED_IP_ERROR | 등록되지 않은 IP |
| UNKNOWN_ERROR | 기타에러 |
xml로 메세지가 반환될 경우 다음과 같은 구조를 갖습니다. (예. 예금상품조회)
＜response＞
＜header＞
＜resultCode＞00＜/resultCode＞
＜resultMsg＞NORMAL_SERVICE＜/resultMsg＞
＜/header＞
＜body＞
＜items＞
＜item＞
＜REGISTER_MAX＞36개월＜/REGISTER_MAX＞
＜ENTR_CUST_DVSN＞개인＜/ENTR_CUST_DVSN＞
＜GOOD_KOR_NM＞우체국Smart퍼즐적금＜/GOOD_KOR_NM＞
＜INTR_PAY_KIND＞만기이자지급식＜/INTR_PAY_KIND＞
＜GOOD_CLSF＞적립식예금＜/GOOD_CLSF＞
＜GOOD_TAXT_DVSN＞일반과세|비과세＜/GOOD_TAXT_DVSN＞
＜MAN1_ACC1_ITMS_YN＞O＜/MAN1_ACC1_ITMS_YN＞
＜INTR_PAY_PSBL_YN＞O＜/INTR_PAY_PSBL_YN＞
＜CARD_ISUE_PSBL_YN＞X＜/CARD_ISUE_PSBL_YN＞
＜REGISTER_MIN＞6개월＜/REGISTER_MIN＞
＜/item＞
＜/items＞
＜/body＞
＜/response＞
＜header＞
＜resultCode＞00＜/resultCode＞
＜resultMsg＞NORMAL_SERVICE＜/resultMsg＞
＜/header＞
＜body＞
＜items＞
＜item＞
＜REGISTER_MAX＞36개월＜/REGISTER_MAX＞
＜ENTR_CUST_DVSN＞개인＜/ENTR_CUST_DVSN＞
＜GOOD_KOR_NM＞우체국Smart퍼즐적금＜/GOOD_KOR_NM＞
＜INTR_PAY_KIND＞만기이자지급식＜/INTR_PAY_KIND＞
＜GOOD_CLSF＞적립식예금＜/GOOD_CLSF＞
＜GOOD_TAXT_DVSN＞일반과세|비과세＜/GOOD_TAXT_DVSN＞
＜MAN1_ACC1_ITMS_YN＞O＜/MAN1_ACC1_ITMS_YN＞
＜INTR_PAY_PSBL_YN＞O＜/INTR_PAY_PSBL_YN＞
＜CARD_ISUE_PSBL_YN＞X＜/CARD_ISUE_PSBL_YN＞
＜REGISTER_MIN＞6개월＜/REGISTER_MIN＞
＜/item＞
＜/items＞
＜/body＞
＜/response＞