이 누리집은 대한민국 공식 전자정부 누리집입니다.
신청·참여
활용방법
소장자료 검색
사용설명소장 자료를 조회할 수 있는 기능을 제공합니다.
요청 URL(request url)https://www.nl.go.kr/NL/search/openApi/search.do
- 오프라인자료(구:소장정보) https://www.nl.go.kr/NL/search/openApi/search.do?systemType=오프라인자료
- 온라인자료(구:디지털화자료) https://www.nl.go.kr/NL/search/openApi/search.do?systemType=온라인자료
- 정부간행물(구:정부간행물) https://www.nl.go.kr/NL/search/openApi/search.do?govYn=Y
요청 변수(request parameter)※단,검색조건 및 맵핑되는 검색어가 하나이상 포함되어야 함
| NO | 요청변수 | 값 | 설명 |
|---|---|---|---|
| 1 | key | String(필수) |
발급키 |
| 2 | srchTarget | - |
total (전체) title (제목) author (저자) publisher (발행자) cheonggu (청구기호) (생략시 전체) |
| 3 | kwd | String |
검색어 |
| 4 | pageNum | Integer (필수) |
현재페이지 |
| 5 | pageSize | Integer (필수) |
쪽당출력건수 (기본 10건) |
| 6 | systemType | String |
오프라인자료 (구: 소장정보) 온라인자료 (구: 디지털화자료) |
| 7 | category | String |
카테고리 도서 고문헌 학위논문 잡지/학술지 신문 기사 멀티미디어 장애인자료 외부연계자료 웹사이트 수집 기타 해외한국관련자료 |
| 8 | lnbTypeName (멀티미디어,장애인자료) |
String |
[멀티미디어 하위분류] 오디오북, 기타 녹음자료 음악자료 지도자료 이미지/사진 컴퓨터파일 영상자료 마이크로자료 복합기록물 SNS 온라인게임 VR, AR, MR [장애인자료 하위분류] 점자자료 장애인대체자료 |
| 9 | offerDcode2s (소장원문) |
String |
[자료제공DB별 자체분류 2차_명] CH4G (한국고전적종합목록) CH4A (고지도) CH48 (신문학대표소설) CH4Q (학술회원자료) CH4E (어린이, 청소년 관련 자료) CH47 (문화체육관광부 발간자료) CH4M (독도관련자료) CH4I (우수학술도서) CH43 (관보(1894~1945)) CH44 (한글판 고전소설) CH4R (교과서) CH4B (연속간행물 귀중본) CH49 (신문(~1950)) CH4P (정부간행물) CH4T (악보) CH4F (일본어자료(~1945)) CH45 (단행자료) CH41 (고서) CH4L (한국관련외국어자료) CH4D (인문과학분야 박사학위논문) CH4J (한국고전백선) CH4K (국내발간 한국관련 외국어자료) |
| 10 | sort | - |
정렬 (생략시 : 정확도순) ititle (제목) iauthor (저자) ipub_year (발행년도) ipublisher (발행처) cheonggu (청구기호) |
| 11 | order | String |
asc (오름차순) desc (내림차순) |
| 12 | apiType | String |
xml json |
| 13 | licYn | - |
원문이용방법(원문저작권) S ([국립중앙도서관,협약도서관]-인쇄 시 과금) F ([국립중앙도서관,협약도서관]-열람,인쇄시 과금) Y ([국립중앙도서관,협약공공도서관,정기이용증소지자]-무료) L ([국립중앙도서관]-무료) N ([관외이용]-무료) C ([국립중앙도서관,작은도서관]-무료) U ([국립중앙도서관,국립어린이청소년도서관]-무료) T ([국립중앙도서관,국립어린이청소년도서관,작은도서관]-무료) R ([국립중앙도서관,정기이용증소지자]-무료) D ([국립중앙도서관,국립어린이청소년도서관,국립세종도서관]-무료) A ([국립중앙도서관,국립어린이청소년도서관,국립세종도서관,정기이용증소지자]-무료) |
| 14 | govYn | String | Y (정부간행물) |
"토지"를 검색할 경우[원문이용방법 관외이용(무료)] : https://www.nl.go.kr/NL/search/openApi/search.do?key=[발급된키값]&apiType=xml&srchTarget=total&kwd=%ED%86%A0%EC%A7%80&pageSize=10&pageNum=1&licYn=N
※ URL(한글)은 반드시 인코딩해야 함
※ 상세검색은 kwd 값이 없을 경우 상세검색으로 인식합니다. Kwd 값과 상세검색 값은 혼용하여 사용이 불가능 합니다.
상세검색 샘플 URL제목:"토지", 저자:"박경리"를 검색할 경우 : https://www.nl.go.kr/NL/search/openApi/search.do?key=[발급된키값]&kwd=%ED%86%A0%EC%A7%80&detailSearch=true&f1=title&v1=%ED%86%A0%EC%A7%80&f2=author&v2=%EB%B0%95%EA%B2%BD%EB%A6%AC
출력결과 필드 (response field)| NO | 필드 | 값 | 설명 |
|---|---|---|---|
| 1 | kwd | - | 검색어 |
| 2 | category | - | 카테고리 |
| 3 | pageNum | - | 현재페이지 |
| 4 | pageSize | - | 쪽당출력건수 (기본 10건) |
| 5 | sort | - | 정렬 |
| 6 | total | - | 검색건수 |
| 7 | title_info | - | 표제 리스트 |
| 8 | type_name | - | 자료유형 |
| 9 | place_info | - | 자료있는곳명칭(본관) |
| 10 | author_info | - | 저작자 |
| 11 | pub_info | - | 발행자 |
| 12 | menu_name | - | 메뉴명 |
| 13 | media_name | - | 매체구분 |
| 14 | manage_name | - | 자료있는곳 명 |
| 15 | pub_year_info | - | 발행년도사항 |
| 16 | control_no | - | 제어번호 |
| 17 | doc_yn | Y[원문있음] , N[원문없음] | 원문유무 |
| 18 | org_link | - | 원문링크 |
| 19 | id | - | 종키 |
| 20 | type_code | - | 자료유형코드 |
| 21 | lic_yn | - | 저작권유무 |
| 22 | lic_text | - | 저작권설명 |
| 23 | reg_date | - | 비치일 |
| 24 | detail_link | - | 상세페이지경로 |
| 25 | isbn | - | ISBN |
| 26 | call_no | - | 청구기호 |
| 27 | kdc_code_1s | - | 동양서분류기호 대분류 코드 |
| 28 | kdc_name_1s | - | 동양서분류기호 대분류 명칭 |
※ 제공서비스에 따라 출력결과 필드는 제한될 수 있습니다. 에러메세지
| 에러코드 | 설명 |
|---|---|
| 000 | SYSTEM ERROR:SYSTEM 오류 |
| 010 | NO KEY VALUE:인증키값 누락 |
| 011 | INVALID KEY:유효하지않은 인증키 |
| 012 | DATA LIMIT 500:검색결과 이동시 500건 제한(500건 이후 데이터 조회불가) |
| 013 | CATEGORY ERROR:카테고리값 입력오류 |
| 014 | PARAMETER VALIDATION ERROR:파라메터 입력값 오류 |
| 015 | REQUIRED PARAMETER MISSING:필수 파라메터 입력 오류(검색어 or 상세검색) |
| 101 | SEARCH ERROR:검색서버 오류 |
