국방부 공공데이터 개방 포털 Open API는 국방부 공공데이터 개방 포털의 다양한 서비스와 데이터를 쉽게 이용할 수 있도록 공개한 인터페이스입니다.
Open API를 이용하는 방법은 다음과 같습니다.
1. 국방부 공공데이터 개방 포털 G-PIN 로그인
2. 참여소통 > 개발자 공간 > 인증키 신청(최초 1회만 신청하면 됩니다)
3. 국방부 공공데이터 개방 포털 Open API에서 이용하고자 하는 서비스 검색 및 이용방법 확인
4. 어플리케이션 제작 및 배포
이용방법에 대해 세부적으로 알아보겠습니다.
Open API 호출을 위해서는 요청주소 및 요청인자를 파악해야 합니다.
해당 정보는 서비스별 Open API 메타 정보 화면에서 확인이 가능합니다.
가. 입력인자 및 호출 URL 확인
호출 URL은 기본적으로 다음과 같은 항목으로 구성되어 있으며 GET방식으로 호출하시면 됩니다.
(브라우저에서 호출URL을 입력하시면 쉽게 확인이 가능합니다)
http://요청주소/인증키/요청파일타입/OpenAPI호출서비스명/요청시작위치/요청종료위치/{검색어}
■ 요청주소 : 기본적으로(http://openapi.mnd.go.kr/ 입니다만 일부 다른 주소를 요청하기도 하므로 확인하세요.
■ 인증키 : 신청한 인증키(sample 키는 최초5건 이내에서만 호출 가능함. 정식 서비스를 위해서는 인증키 발급 필수)
■ 요청파일타입 : Open API 호출 결과물의 파일 형태를 지정합니다.(xml, xls, json 중 택 일)
■ OpenAPI 호출서비스명 : 각 Open API 별로 고유한 영문서비스명을 제공합니다.(요청인자 3번째 항목)
■ 요청시작위치 : 호출하고자 하는 데이터 목록의 시작위치
■ 요청종료위치 : 호출하고자 하는 데이터 목록의 종료위치
■ {검색어} : 요청인자 6번째 항목부터 설명하는 대로 검색어를 입력하시면 됩니다.
필수 검색어는 반드시 입력하셔야 하며, 선택 검색어는 입력하지 않아도 되지만 다음 검색항목이 있는 경우 반드시 공백을 입력하셔야 정상 검색이 됩니다.
예를 들어 /검색어1(필수)/검색어2(선택)/검색어3(선택) 일 경우
- /검색어1(필수)/ : 정상
- / : 오류(필수 검색어 누락)
- /검색어2(선택)/ : 비정상(오류는 나지 않지만, 원치 않는 검색 결과)
- /검색어1(필수)/검색어2(선택)/ : 정상
- /검색어1(필수)/검색어3(선택)/ : 비정상 (오류는 나지 않지만, 원치 않는 검색 결과)
- /검색어1(필수)/(공백필수)/검색어3(선택)/ : 정상
나. 출력값 및 에러 메시지 확인
■ 출력 값(Out Result_ : 출력 컬럼 확인
■ 에러 및 정보 메시지 : 출력 오류에 대한 메시지 확인