Postcodify 매뉴얼

API 에뮬레이션 기능 안내

개요

에뮬레이션은 Postcodify의 자체 포맷이 아닌 다른 API의 포맷으로 데이터를 반환하는 기능입니다. 에뮬레이션을 사용하면 다른 API와 연동하도록 만들어진 어플리케이션도 쉽게 Postcodify와 연동할 수 있습니다.

에뮬레이션 대상에는 오픈소스 API만 포함됩니다. 상용 API나 서버측 소스가 공개되어 있지 않은 API는 에뮬레이션하지 않습니다.

그누보드 API 에뮬레이션

그누보드 제작사인 (주)SIR에서 운영하던 도로명주소 검색 API는 편리한 사용 방법과 빠른 검색 속도, 높은 안정성으로 국내 웹개발자들의 많은 사랑을 받아왔으나 2014년 10월 31일에 서비스가 중단되었습니다.

기존 서비스에 사용하던 소스는 이곳에 공개되어 있지만, Sphinx 검색엔진을 사용해야 하기 때문에 일반적인 PHP·MySQL 환경에서 직접 사용하기는 어렵습니다.

그누보드 최신 버전은 다음 우편번호 서비스로 전환하였지만, 다음 API 적용이 곤란하거나 적용을 원하지 않는 경우, 그누보드 외의 어플리케이션에서 그누보드 API와 연동하던 경우에는 Postcodify의 에뮬레이션 기능을 통해 기존의 그누보드 API를 계속 사용하는 것과 같은 효과를 얻을 수 있습니다.

그누보드 구 버전을 사용하시는 분들은 js/zip.js 파일에서 아래의 내용을 찾아

$.getJSON("//juso.sir.co.kr/search.php?sido=  ... (후략)

아래와 같이 변경해 주시면 됩니다.

$.getJSON("//api.poesis.kr/post/search.php?sido=  ... (후략)

2015년 8월 시행되는 새우편번호를 입력받으려면 아래와 같이 변경해 주십시오.

$.getJSON("//api.poesis.kr/post/search.php?pc=5&sido=  ... (후략)

새우편번호가 기존 우편번호처럼 두 칸에 나뉘어 입력되는 것이 보기 싫은 분은 아래와 같이 변경해 주십시오.

$.getJSON("//api.poesis.kr/post/search.php?pc=5&merge=Y&sido=  ... (후략)

마지막 옵션을 사용하시는 경우, 검색 결과를 표시할 때 그누보드 주소 입력란의 스타일을 변경하는 스크립트를 함께 전송해 드립니다. 사용하시는 스킨에 따라 작동하지 않을 수도 있으니 충분히 테스트해 보시기 바랍니다.

반환되는 데이터 포맷은 우측 상단의 “Powered by Postcodify”라는 메시지를 제외하면 기존의 그누보드 API와 동일하며, “Powered by Postcodify” 메시지를 보고 싶지 않으신 분은 아래의 CSS를 사용하여 쉽게 지울 수 있습니다.

div.powered_by_postcodify { display: none; }

그 밖의 어플리케이션에서 그누보드 API를 사용하시던 분들도 위와 같이 URL을 변경해 주시면 됩니다. 단, sido, gugun, q 파라미터는 반드시 넘겨주셔야 합니다. 파라미터가 누락되면 에뮬레이션이 되지 않습니다.

Postcodify 검색서버를 직접 구축하신 경우에는 lib/emulators/sir.php를 사용하시면 됩니다.

Postcodify는 그누보드 제작사인 (주)SIR과 어떤 관계도 없으며, 공개된 소스와 유사한 API를 제공하는 것 뿐입니다.

XE krzip API 에뮬레이션

XE에서 운영하던 우편번호 검색 서버는 2015년 4월 20일부로 서비스가 종료되었습니다. 최신 버전의 krzip 모듈을 사용하면 다음 및 우체국 API와 연동이 되지만, 데이터 포맷이 달라졌기 때문에 일부 사이트에서는 적용하기 어려울 수도 있습니다.

기존의 krzip 모듈을 계속 사용하셔야 하는 경우에는 운영하시는 XE 사이트의 관리 페이지에서 고급설치된 모듈한국 우편번호를 클릭하신 후 아래와 같이 설정을 변경해 주시기 바랍니다.

  • 우편번호 검사 서버 이름 : api.poesis.kr
  • 우편번호 검사 서버 경로 : /post/search.php

Postcodify API는 XE krzip API와 몇 가지 차이가 있으니 유의하시기 바랍니다.

  • 광역시·도를 선택한 후 시·군·구를 별도로 선택하지 않고 바로 검색을 수행할 수 있습니다.
  • 검색 결과를 한 화면에 20건이 아닌 100건씩 보여주는 대신, 100건을 초과하여 검색할 수는 없습니다. (그러나 정확한 도로명주소나 지번으로 검색한 경우 결과가 20건 이상 나오는 일은 거의 없습니다.)
  • 대표지번이 아닌 지번주소, 사서함 주소 등도 검색이 가능합니다.
  • 비교적 최근 버전의 krzip 모듈을 에뮬레이션하므로, 아주 오래된 모듈 사용시 호환이 되지 않을 수도 있습니다.

그 밖의 어플리케이션에서 XE krzip API를 사용하시던 분들도 위와 같이 URL을 변경해 주시면 됩니다. 단, request 또는 search_word 파라미터는 반드시 넘겨주셔야 합니다. 파라미터가 누락되면 에뮬레이션이 되지 않습니다.

Postcodify 검색서버를 직접 구축하신 경우에는 lib/emulators/xe.php를 사용하시면 됩니다.

Postcodify는 XE 프로젝트와 어떤 관계도 없으며, 공개된 소스와 유사한 API를 제공하는 것 뿐입니다.

쿼리수 제한 및 가중치 안내

에뮬레이션 기능을 사용하시더라도 도메인당, IP당 일일 쿼리수 제한 및 가중치 부여 기준은 다른 방법으로 Postcodify 무료 API를 사용하실 때와 동일하게 적용됩니다.

웹 이외의 방법으로 API를 호출하시는 경우 반드시 ref 파라미터에 도메인을 적어 주시기 바랍니다. (웹에서 호출할 때는 리퍼러 값을 자동으로 파악합니다.) 도메인 정보가 누락되거나 정확하지 않을 경우 일일 쿼리수 제한이 다른 도메인과 합산되어 불이익을 받으실 수 있으니 주의해 주십시오.