행정안전부 국가기록원

OpenAPI 템플릿

오픈 API 탬플릿 소개

‘오픈 API 템플릿’은 나라기록에서 제공하는 Open API를 손쉽게 이용할 수 있도록 하기 위한 Open API이용 샘플 코드입니다.
HTML과 자바스크립트에 대한 약간의 지식만 있다면, 누구나 손쉽게 동작 구조를 손쉽게 파악하고, 수정하여 활용할 수 있습니다.


오픈API템플릿 구성

오픈 API템플릿은 oat.html과 oat.xsl 두개의 파일로 구성되어 있습니다.

  • oat.html : 검색어를 입력 받고 오픈 API를 호출 기능 HTML 페이지
  • oat.xsl : 오픈 API검색결과를 변환, 화면 U/I

오픈API템플릿 이용방법

제공되는 오픈API템플릿 구성 파일을 다운로드 받은 뒤, 웹서버에 복사해 넣고, oat.html 파일에 Open API 신청 시 발급받은 인증키를 아래 위치에 기입합니다.

오픈API템플릿 구성 파일 다운로드

오픈API템플릿 이용 - 기록물 검색
기록물 검색
입력소스 <form name="openapi" onSubmit="return displayResult()"> <input type="hidden" name="key" value="이곳에_인증키를_기입하세요 "/> <input type="text" name="query" value=""/> <input type="submit" value="검색"/> </form>
이용 예 기록물 검색 이용 예 예시 캡쳐화면

오픈API템플릿 이용 - 컬렉션/토픽, 지식콘텐츠 검색
컬렉션/토픽, 지식콘텐츠 검색
입력소스 <form name="openapi" onSubmit="return displayResult()"> <input type="hidden" name="key" value="이곳에_인증키를_기입하세요 "/><BR> <input type="text" name="query_field" value="auth"/><BR> <input type="text" name="query" value="국가기록원"/><BR> <input type="text" name="start_row" value="0"/><BR> <input type="text" name="size" value="10"/><BR> <input type="submit" value="검색"/> </form>
이용 예 컬렉션/토픽, 지식콘텐츠 검색 이용 예 예시 캡쳐화면