OpenAPI 사용법
나라기록물 검색서비스 OpenAPI 소개
- 국가기록원에서는 나라기록물 검색 서비스 OpenAPI 제공을 통해 IT 환경의 변화 속에서 기존의 복잡하고 비용이 높은 웹서비스 대신 개방형, 경량화 연계 지원으로 국민과 기업이 가치를 창출할 수 있도록 지원하고자 합니다.
- 나라기록물 검색서비스 OpenAPI는 기록물에 대한 검색 결과를 RSS형식으로 전달하는 API서비스이며, OpenAPI를 통한 질의건수는 하루 사용량 1,000건 미만으로 제한하고 있습니다.
- 질의건수 제한없이 OpenAPI를 사용하시려면, 국가기록원 담당자(서비스정책과, 031-750-2026)에게 별도 문의하여 주시기 바랍니다.
이용방법
1. 인증키 발급 받기
-
나라기록물 검색서비스 OpenAPI를 이용하시려면, 인증키가 필요합니다.
- 인증키 : API 서비스 이용 승낙을 받은 기관 또는 이용자임을 식별할 수 있는 고유 값
-
인증키를 발급 받기 위해 공공데이터 포털(www.data.go.kr)에 가입하시기 바랍니다.
- 가입 후, 아래와 같이 ‘데이터셋-오픈 API’ 메뉴에서 ‘나라기록물 검색 서비스’를 검색하셔서 제목을 클릭하신 후 개발계정을 신청하셔야 합니다.
- 이후, 인증키 발급 절차는 아래의 ‘Open API 인증키 발급 안내’ 클릭 후, ‘2. 공공데이터 활용방법>2-2 오픈 API’의 페이지 중간 ‘오픈 API
활용신청’의 개발계정 신청 단계부터
참고하여 진행하시기
바랍니다.
Open API 인증키 발급 안내 바로가기
- 가입 후, 아래와 같이 ‘데이터셋-오픈 API’ 메뉴에서 ‘나라기록물 검색 서비스’를 검색하셔서 제목을 클릭하신 후 개발계정을 신청하셔야 합니다.
2. 인증키 테스트
- 아래 입력창에 발급받은 인증키를 입력하여 정상 인증키인지 확인하실 수 있습니다.
인증키 입력 | 인증키 (디코딩): 확인 |
---|---|
정상 테스트 화면 |
![]() |
- 아래 입력창에 발급받은 인증키를 입력하여 정상 인증키인지 확인하실 수 있습니다.
요청 주소 | https://search.archives.go.kr/openapi/search.arc?serviceKey=인증키(인코딩)&query=검색어(UTF-8) |
---|
- 1) 요청 변수(request parameter)
요청변수 | 필수 | 설명 |
---|---|---|
key | O | OpenAPI 사용 인증키, UTF-8 인코딩입니다. |
query | O | 검색을 원하는 질의, UTF-8 인코딩입니다. |
rc_type | 철건 구분 [철:rfile, 건:ritem] | |
display | 한 페이지에 출력될 결과수 | |
pageno | 조회페이지 |
- 2) 출력 결과 필드 (response field)
필드 | 설명 |
---|---|
channel | 검색 결과를 포함하는 컨테이너입니다. |
title | API 제목(국가기록원 오픈 API 검색결과) |
total | 검색 결과 문서의 총 개수를 의미합니다. |
rc_type | 기록물구분값 (RFILE:철 RITEM:건) |
rc_code | 기관구분값 |
rc_rfile_no | 기록물 철ID |
rc_ritem_no | 기록물 건ID |
title | 기록물 제목 |
mgt_org_name | 기여자 정보 |
prod_name | 생산기관 |
prod_year | 생산년도 |
is_open | 공개구분값 (1:공개 2:부분공개 3:비공개) |
arcave_type | 기록물 구분 (01:일반기록물, 02:시청각기록물,04:총독부기록물, 05:정부간행물, 06:해외기록물, 07:역사기록물, 08:행정박물, 09:민간기록물, 10:영화필름, 11:방송프로그램, 12:구술기록) |
doc_type | 기록물 형태 (1:행정박물(관인류), 2:행정박물(상징기념물), 3:행정박물(사무집기류), 4:행정박물(기타), A:일반문서류, B:도면류, C:사진,필름류, D:녹음,동영상류, E:카드류, F:대장류, G:국무회의록, H:지도, M:정부간행물, O:일반도서, P:총독부간행물) |
online_reading | 원문온라인열람서비스 (Y : 가능 , N : 불가) |
link | 기록물 상세정보페이지 링크 |
- 3) 에러 메세지
0001 | System error. 시스템에러가 발생했습니다. |
---|---|
1001 | Unregistered Key. 등록되지 않은 인증키입니다. |
2001 | No Query Value. 주 검색질의어(query value)가 없습니다. |
3001 | Query Count is over the Limit. 허용된 최대 검색허용 횟수를 초과 했습니다. |
9001 | Unknown Error 정의되지 않은 오류가 발생했습니다. (구체적인 에러 표시) |