이 페이지의 구성
오픈API 상세
| 항목명(국문) | 항목명(영문) | 항목크기 | 항목구분 | 샘플데이터 | 항목설명 |
|---|---|---|---|---|---|
| 서비스키 | serviceKey | 400 | 필수 | 인증키 (URL Encode) | 공공데이터포털에서 받은 인증키 |
| 페이지 번호 | pageNo | 4 | 필수 | 1 | 페이지 번호 |
| 한 페이지 결과 수 | numOfRows | 4 | 필수 | 10 | 한 페이지 결과 수 |
| 주택가격 | housePrc | 10 | 필수 | 250000000 | 주택 가격 |
| 주택구분코드 | houseDvcd | 2 | 필수 | 01 | 01: 일반주택 02: 노인복지주택 |
| 연금지급방식구분코드 | pnsnPayMthdDvcd | 2 | 필수 | 01 | 01: 종신지급 02: 종신혼합 04: 확정혼합 06: 대출상환 07: 우대지급 08: 우대혼합 |
| 월지급금증감구분코드 | mmPayAmtIndcDvcd | 2 | 필수 | 01 | 01: 정액형 31:정기증가형 41:초기증액형(10년) 42:초기증액형(7년) 43:초기증액형(5년) 44:초기증액형(3년) |
| 가입자출생일자 | joinPersBrthDy | 8 | 필수 | 19510205 | 주택소유자 생년월일 |
| 배우자 출생일자 | sposBrthDy | 8 | 옵션 | 19540605 | 배우자 생년월일 |
| 지급기간코드 | payTermCd | 2 | 필수 | 01 | 01: 종신(연금지급방식 구분코드: 01,02,06,07,08인 경우) 02: 30년 03: 25년 04: 20년 05: 15년 06: 10년 |
| 인출한도설정금액 | wdrwLmtSetpAmt | 10 | 옵션 | 1000000 | 인출한도설정금액 |
| 데이터타입 | dataType | 4 | 옵션 | XML | 오픈 API에서 제공할 데이터 타입을 대문자 문자열로 지정 - 데이터 타입 지원 형식 XML/JSON 단, 시스템에서 정의된 디폴트 포맷의 요청인 경우 생략 가능 |
| 항목명(국문) | 항목명(영문) | 항목크기 | 항목구분 | 샘플데이터 | 항목설명 |
|---|---|---|---|---|---|
| 결과코드 | resultCode | 2 | 필수 | 00 | 결과코드 |
| 결과메시지 | resultMsg | 50 | 필수 | NORMAL SERVICE | 결과메시지 |
| 한 페이지 결과 수 | numOfRows | 4 | 필수 | 10 | 한 페이지 결과 수 |
| 페이지 번호 | pageNo | 4 | 필수 | 1 | 페이지 번호 |
| 데이터 총 개수 | totalCount | 4 | 필수 | 1 | 데이터 총 개수 |
| 월지급금 | monPmtAmt | 10 | 필수 | 603360 | 월지급금 |
| 최대인출한도 | ImaxAmt | 10 | 필수 | 54125000 | 최대인출한도 |
| 에러메시지 | 에러코드 | 설명 |
|---|---|---|
| APPLICATION_ERROR | 01 | GW 내부 처리 중 예기치 않은 오류가 발생했습니다. 잠시 후 다시 호출하고, 문제가 반복되면 활용지원센터로 문의해 주세요. |
| HTTP_ERROR | 04 | 허용되지 않은 HTTP 요청이거나 기관 API 응답 처리에 실패했습니다. 요청 방식과 호출 URL을 확인해 주세요. |
| SERVICETIMEOUT_ERROR | 05 | 기관 API 또는 GW 연계 서비스와의 연결에 실패했거나 응답 대기시간을 초과했습니다. 잠시 후 다시 호출해 주세요. |
| INVALID_REQUEST_PARAMETER_ERROR | 10 | 요청 파라미터의 값이나 형식이 올바르지 않습니다. API 명세에서 파라미터 이름, 형식 및 허용값을 확인해 주세요. |
| NO_OPENAPI_SERVICE_ERROR | 12 | 요청한 오픈API 서비스가 존재하지 않거나 폐기되었습니다. 호출 URL에 오타가 없는지 확인해 주세요. |
| SERVICE_KEY_IS_NULL | 20 | 요청에 API 인증키가 포함되지 않았습니다. 공공데이터포털에서 발급받은 인증키를 요청 파라미터에 포함해 주세요. |
| PERMISSION_DENIED | 20 | GW 접근 권한 검사에서 요청이 거부되었습니다. 해당 API의 활용신청 및 접근 권한을 확인해 주세요. |
| LIMITED_NUMBER_OF_SERVICE_REQUESTS_EXCEEDS_ERROR | 22 | API 서비스의 일일 호출 허용량을 초과했습니다. 호출량이 초기화된 이후 다시 이용하거나 트래픽 증설을 신청해 주세요. |
| LIMITED_NUMBER_OF_SERVICE_REQUESTS_PER_SECOND_EXCEEDS_ERROR | 23 | 짧은 시간에 많은 요청이 발생하여 초당 호출 허용량을 초과했습니다. 잠시 후 다시 호출해 주세요. |
| BLACKLIST_IP_ACCESS_ERROR | 29 | 차단된 IP에서 호출한 요청입니다. 호출 서버의 IP를 확인하고, 차단 해제가 필요한 경우 활용지원센터로 문의해 주세요. |
| 에러메시지 | 에러코드 | 설명 |
|---|---|---|
| SERVICE_ACCESS_DENIED_ERROR | 20 | 해당 API 서비스에 대한 이용 권한이 확인되지 않습니다. 활용신청 여부와 승인 또는 일시중지 상태를 확인해 주세요. |
| SERVICE_KEY_IS_NOT_REGISTERED_ERROR | 30 | 등록되지 않은 API 인증키입니다. 인증키가 정확한지와 해당 서비스의 활용신청이 정상적으로 완료되었는지 확인해 주세요. |
| DEADLINE_HAS_EXPIRED_ERROR | 31 | API 인증키의 사용 기한이 만료되었습니다. 공공데이터포털에서 이용 기간을 확인하거나 갱신해 주세요. |
기업회원입니다. 활용신청할 서비스키를 선택해주세요