::::::검색서비스 공동활용 - OpenAPI 활용 도움말:::::

내홈>도움말>검색서비스활용>OpenApi활용

검색서비스 l 개인화서비스 l 나라기록100배활용하기 l 검색서비스활용 l 검색도구 l FAQ

[1] 나라기록검색 OpenAPI서비스 소개

나라기록 검색서비스에서는 국가기록물에 대해 공개 활용 활성화 등 IT 환경의 변화속에서 기존의 복잡하고 비용이 높은 웹서비스 대신 개방형, 경량화 연계 지원으로 국민과 기업이 가치를 창출할 수 있는 전자정부 서비스를 발굴 제공하고 있습니다.
나라기록검색의 검색엔진이 찾아낸 기록정보 검색결과를 API로 이용하여 기록정보 검색결과를 활용 해보세요

나라기록검색OpenAPI 이용약관 보기

[2] 인증키 발급 받기

나라기록검색 서비스를 이용하시려면, 인증키가 필요합니다. 인증키는 API 서비스 이용 승낙을 받은 기관 또는 이용자임을 식별할 수 있는 고유 값을 의미합니다

1) 인증키 발급 요청

나라기록검색 서비스 담당자에게 아래 정보를 작성, 이용등록 요청하고 인증키를 발급 받으세요

이용등록 요청 메일주소<arc-search@mopas.go.kr>

  - 기관명
  - 기관주소
  - 담당자명
  - 전화번호
  - 이메일
  - 사용목적

2) 인증키 테스트

발급 받은 인증키를 이용하여 API 호출 결과를 아래와 같이 확인 하실 수 있습니다

API 이용 테스트하기( http://search.archives.go.kr/openapi/search_test.htm )

3) 트래픽 제한

나라기록검색 OpenAPI를 통한 질의건수는 하루 사용량 1,000건 미만으로 제한하고 있습니다
질의건수 제한없이 OpenAPI를 사용 하시려면, 나라기록검색 담당자에게 별도 문의하여 주십시오.

[3]나라기록검색 OpenAPI 사용법

나라기록검색 OpenAPI는 기록물에 대한 검색 결과를 외부에 RSS형식으로 전달하는 API서비스입니다.
기록물 검색과 컬렉션/토픽, 지식콘텐츠 검색 서비스를 제공합니다.

● 기록물검색

1) 요청 주소(request url)

http://search.archives.go.kr/openapi/search.arc

발급 받은 인증키를 이용하여 아래와 같은 형식으로 서비스를 호출할 수 있습니다. 검색어는 UTF-8 인코딩을 사용합니다.

http://search.archives.go.kr/openapi/search.arc?key=인증키&query=검색어

2) 요청 변수(request parameter)

요청변수	필수	설명
key	O	OpenAPI 사용 인증키
query	O	검색을 원하는 질의, UTF-8 인코딩입니다.
rc_type	O	철건 구분 [철:rfile, 건:ritem]
query_type		검색방식(키워드:지정안함,전후방일치:ftr)
query_field		검색영역(전체:지정안함,제목:TITLE,정보:DESCRIPTION태그:TAG)
query_phrase		다음 문구 정확하게 포함(query에서 ""로 질의한것과 동일)
query_or		다음 단어 적어도 하나 포함 (query에서 연산자 'OR' 사용과 동일)
query_exclude		다음 단어 제외(query에서 연산자 'NOT' 사용과 동일)
prod_year_start		생산년도 시작[형식 : 년도 4자리]
prod_year_end		생산년도 완료[형식 : 년도 4자리]
prod_code		생산기관 기관 코드[GCC 정부 기관 코드]-해당기관만 검색 ☞ 행정표준코드관리시스템에서 기관코드 참조 ☞ 정부기관코드가 없는 기관은 '기록물 구분' 등 다른 검색조건을 사용하세요.(예:총독부)
prod_dir_code		생산기관 기관 코드[GCC 정부 기관 코드]-하위기관 포함 검색 ☞ 행정표준코드관리시스템에서 기관코드 참조
is_open		공개 여부[공개:1, 비공개:2, 부분공개:3]
online_reading		원문서비스 유무[제공:Y, 비제공:N]
record_type		기록물 구분 [A : 일반 기록물, A1 : 일반문서, A2:역사기록, A3:총독부기록, A4:해외기록, A5:민간기록, B:시청각 기록, C : 간행물, C1:정부간행물, C2:일반도서, C3:총독부간행물, D:행정박물]
doc_type		기록물 형태 [A : 일반문서류, B : 도면류, C : 사진,필름류, D : 녹음,동영상류, E : 카드류, F : 대장류, G : 국무회의록, M : 정부간행물, H : 지도, 1 : 행정박물(관인류), 2 : 행정박물(상징기념물), 3 : 행정박물(사무집기류), 4 : 행정박물(기타), O : 일반도서 , P : 총독부간행물, I : 대통령전자문서 ]
mgt_organ		관리기관[기록관:1, 영구기록물관리기관:2]
sort		정렬 속성[생산년도:PRODYEAR, 제목순:TITLE] 지정을하지 않거나 빈값이면 검색어와 일치하는 정확도 순으로결과를 출력합니다.
order		정렬 순서[오름차순:ASC, 내림차순:DESC]
display		페이지당 출력수 (기본 : 10)
pageno		현재 페이지 (기본 : 1)

3) 출력 결과 필드 (response field)

필드	값	설명
rss	-	RSS 리더기만으로 이용할 수 있게 하기 위해 만든 RSS 포맷의 컨테이너입니다.
channel	-	검색 결과를 포함하는 컨테이너입니다.
title
total_count		검색 결과 문서의 총 개수를 의미합니다
item	-	개별 검색 결과입니다.
rc_type		개별 검색 결과 철/건구분(철:RFILE/건:RITEM)
rc_code	-	기록물 연계 기관 번호,기록물 철 번호,기록물 건 번호를 뜻합니다. 내부적으로 검색된 해당 기록물을 찾아가기 위한 키로 사용됩니다.
rc_rfile_no
rc_ritem_no
title	string	검색결과 문서의 제목[철제목, 건제목]
mgt_org_name	string	소장기관명
prod_name	string	생산기관명
prod_year	숫자	생산년도
is_open	숫자	공개구분
arcave_type	문자	기록물 유형 [01:일반기록물, 02:시청각기록물, 03:대통령기록물, 04:총독부기록물, 05:정부간행물, 06:해외기록물, 07:역사기록물, 08:행정박물, 09:민간기록물, 10:영화필름, 11:방송프로그램]
doc_type	문자	기록물 형태 [1:행정박물(관인류), 2:행정박물(상징기념물), 3:행정박물(사무집기류), 4:행정박물(기타), A:일반문서류, B:도면류, C:사진,필름류, D:녹음,동영상류, E:카드류, F:대장류, G:국무회의록, H:지도, I:대통령전자문서, M:정부간행물, O:일반도서, P:총독부간행물]
online_reading	문자	기록물 원문 열람 서비스 여부 [Y:온라인제공, N:온라인 미 제공]
link	string	검색 결과 문서의 하이퍼텍스트 link를 나타냅니다.

4 ) 에러 메세지

0001	System error. 시스템에러가 발생했습니다.
1001	Unregistered Key. 등록되지 않은 인증키입니다.
2001	No Query Value. 주 검색질의어(query value)가 없습니다.
3001	Query Count is over the Limit. 허용된 최대 검색허용 횟수를 초과 했습니다.
9001	Unknown Error 정의되지 않은 오류가 발생했습니다. (구체적인 에러 표시)

● 컬렉션/토픽, 지식콘텐츠 검색

1) 요청 주소(request url)

http://search.archives.go.kr/openapi/searchEx.arc

발급 받은 인증키를 이용하여 아래와 같은 형식으로 서비스를 호출할 수 있습니다. 검색어는 UTF-8 인코딩을 사용합니다.

http://search.archives.go.kr/openapi/searchEx.arc?key=인증키&query=검색어

2) 요청 변수(request parameter)

요청변수	필수	설명
key	O	OpenAPI 사용 인증키
query	O	검색을 원하는 질의, UTF-8 인코딩입니다.
query_field	O	검색영역 [컬렉션:collection, 지식콘텐츠:auth]
start_row		조회 시작 로우
size		조회 개수

3) 출력 결과 필드 (response field)

필드	값	설명
title	문자	검색결과제목
collection_id	숫자	컬렉션/토픽 ID
archive_evnt_id	숫자	기록물 건 번호
archive_evnt_modf_name	문자	컬렉션 / 토픽 요약내용
arid	숫자	지식콘텐츠 ID
from_ymd	숫자	기간 시작
to_ymd	숫자	기간 종료
career_desc	문자	인물 요약 내용
etc_desc	문자	사건 요약 내용
organ_history	문자	기관 요약 내용
prl_ttl	문자	별칭 (영문, 한문 등)

4 ) 에러 메세지

0001	System error. 시스템에러가 발생했습니다.
1001	Unregistered Key. 등록되지 않은 인증키입니다.
2001	No Query Value. 주 검색질의어(query value)가 없습니다.
3001	Query Count is over the Limit. 허용된 최대 검색허용 횟수를 초과 했습니다.
9001	Unknown Error 정의되지 않은 오류가 발생했습니다. (구체적인 에러 표시)