[OpenAPI] 공공데이터 포털 API 사용법

OpenAPI(Open Application Programming Interface, 공개 API) 

오픈 API(Open Application Programming Interface, Open API, 공개 API) 또는 공개 API는 개발자라면 누구나 사용할 수 있도록 공개된 API를 말하며, 개발자에게 사유 응용 소프트웨어나 웹 서비스의 프로그래밍 적인 권한을 제공한다. [1][2] 반대말은 프라이빗 API(Private API)다. 쉽게 말하면, "하나의 웹 사이트에서 자신이 가진 기능을 이용할 수 있도록 공개한 프로그래밍 인터페이스가 오픈 API다"라고 정의할 수 있다(출처: 위키백과)

 

공공데이터 포털 API 사용법

대한민국 정부에서는 공공데이터포털을 통해 도로명 주소 조회 서비스, 동네예보정보조회서비스 등 오픈 API 2,506건을 2018년 현재 운영 및 제공하고 있다.(출처: 위키백과)

0. 공공데이터 포털 회원 가입

https://data.go.kr/

공공데이터포탈 메인페이지 https://data.go.kr/

 

1. 원하는 오픈 API 선택해서 '활용신청' 누르기

https://www.data.go.kr/tcs/dss/selectApiDataDetailView.do?publicDataPk=15077586

공공데이터활용지원센터_코로나19 예방접종센터 조회서비스

2. 활용 목적 선택, 작성하고 활용 신청

웹사이트 개발, 앱개발(모바일, 솔루션 등) 기타, 참고자료, 연구(논문 등) 에서 선택하고 활용 이유에 대해서 작성 

3. 1~2시간 후 승인 여부 나오면 마이페이지 > 오픈 API > 개발계정 상세보기로 이동

4. 하단의 API 명세서 확인

API 호출 시 하단과 같은 객체를 반환함

5. 상단의 서비스 정보에서 일반 인증키(decoding) 복사하기

허용된 개인에게 발급한 인증키로 누가 소유하는지 구별하기 때문에 본인의 인증키를 외부에 공유하지 않도록 주의

6. 인증키 설정을 클릭하여 복사한 인증키 붙여 넣기

 Header에 인증키를 사용하는 경우 Prefix Infuser를 추가하여 사용 가능합니다.

e.g. Infuser <본인의 decoding key 붙여 넣기>

해당하는 방법을 선택해서 설정을 누르면 하단과 같이 바뀜

7. GET 클릭해서 OpenAPI  테스트해보기

GET 클릭하면 하단의 이미지와 같이 펼쳐짐

OpenAPI 실행 준비 버튼을 누르면 화면 전환됨

쿼리 파라미터 

page 각 페이지

perPage 지정한 페이지에서 지정한 페이지 사이즈만큼 가져옴(기본값 10개)

returnType JSON( 기본값) , XML

'OpenAPI호출'을 눌르면 화면이 하단처럼 바뀌면서 json형태의 데이터가 나옴

 

활용

• API 호출해서 데이터 가공해서 데이터베이스에 저장
  • 미리 저장하여 퍼포먼스 향상
  • 하루에 가능한 호출 제한 수가 있음
• 일정 시간마다 API 호출해서 데이터베이스 갱신