KORCIS Open API 가이드 - nl.go.kr · 2 TOTAL 검색건수 3 RECORD 검색 결과...

KORCIS Open API

가이드

2016. 01.

국립중앙도서관

목 차

1. Open API 개요 .................................................................................................................. 1

1.1. Open API 정의 ........................................................................................................... 1

1.2. Open API 동작원리 .................................................................................................. 1

1.3. Open API표 ................................................................................................................ 1

2. 자료검색 ............................................................................................................................... 2

2.1. 검색 ................................................................................................................................ 2

2.2. 상세정보요청 .............................................................................................................. 7

2.3. 원문자료검색 ........................................................................................................... 10

3. 사용 예시 .......................................................................................................................... 15

3.1. 간략 검색 ................................................................................................................... 15

3.2. 원문 검색 ................................................................................................................... 19

- 1 -

1. Open API 개요

1.1. Open API 정의

Open API란 일반적으로 웹 서비스(Web Services)형태로써 특정 기능 혹은 콘텐츠 서비스를 위해

외부에 접근 방법을 공개한 형태를 개방형 인터페이스(이하 OPENAPI)라 합니다.

1.2. Open API 동작원리

API의 동작 단계는 이용자 입장에서 요청(request)하는 단계와, 결과(response)값을 받아 해석(parse)

하는 단계로 구성됩니다.

이용자는 해당 Open API 주소 뒤에 매개변수 값을 붙이는 GET 방식 또는 페이지 폼 안의 변수에

대한 POST 전달 방식을 통하여 API 매개변수 값을 전달하고, 서버에서 처리 수행한 결과를 반환

받습니다.

- GET 방식 매개변수 구성 예시: 요청 URL?변수 1=변수값 1&변수 2=변수값 2... (‘&’표기로 변수구분)

1.3. Open API표

분류 API

자료검색

검색

상세정보요청

- 2 -

2. 자료검색

2.1. 검색

한국고전적종합목록(KORCIS)의 자료를 조회할 수 있는 기능을 제공합니다.

2.1.1. 요청 URL(request url)

https://www.nl.go.kr/korcis/openApi/open.php?요청변수=값

2.1.2. 요청 변수 (request parameter)

NO 변수명 값 설명

1 page Integer(필수) 페이지

2 search_field1 String(필수)

검색조건 1

전체: total_field

표제/논문명: title

저자: author

발행자/대학명 : publisher

3 value1 String(필수) 검색어 1

4 and_or_not1 String : AND/OR/NOT 검색어 연결조건 1

5 search_field2 String

검색조건 2


저자: author

발행자/대학명: publisher

6 value2 String 검색어 2



검색조건 3


저자: author



https://www.nl.go.kr/korcis/openApi/open.php

https://www.nl.go.kr/korcis/openApi/open.php

- 3 -


11 search_field4 String 검색조건 4

12 value4 String

검색어 4


저자: author




검색조건 5


저자: author



16 gubun1 String

표준부호

ISBN: st_code

ISSN: st_issn

CODEN: st_coden

STRN(표준기술보고서번호): st_strn

RNSTRN(보고서번호): st_rnstrn

국가서지번호: st_cbn

저작권등록번호: st_can

17 code1 String 표준부호 값

18 gubun2 String

분류기호

KDC(한국십진분류법): kdc_class

KDCP(한국십진분류표-박봉석편): kdcp_class

DDC(듀이십진분류법): ddc_class

CEC(조선총독부신서부분류표): cec_class

CWC(조선총독부 양서부분류표): cwc_class

COC(조선총독부고서부분류표) : coc_class

19 code2 String 분류기호 값

20 start_year Integer 발행년도 시작

- 4 -

21 end_year Integer 발행년도 끝

22 maxCount String 최대검색건수

23 sort_ksj String 정렬조건

24 hanja_trans String (null / Y) 한자한글변환

25 per_page Integer(필수) 쪽당출력건수 (기본 10건)

- 5 -

2.1.3. 출력 결과 필드 (response field)

NO 결과 값 설명

1 METADATA 루트 엘리먼트

2 TOTAL 검색건수

3 RECORD 검색 결과 컨테이너(레코드 수만큼 반복)

4 NUMBER Integer 출력리스트 번호

5 TITLE String 서명

6 AUTHOR String 저자

7 PUBLISHER String 발행자

8 PUBYEAR String 발행년도

9 TYPE String 자료유형

10 CONTENTS String 목차여부

11 LIB_NAME String 도서관명

12 LIB_CODE Integer 도서관부호

13 REC_KEY Integer 서지정보 키

샘플 URL : ‘김해김씨’ 검색

https://www.nl.go.kr/korcis/openApi/open.php?page=1&search_field1=total_field&and_or_

no t1=NOT&value1=%EA%B9%80%ED%95%B4%EA%B9%80%EC%94%A8&maxCount=10

00&per_page=10

- 6 -

2.1.4. 비고/에러 메시지

NO 에러코드 설명


2 ERR_INFO 에러정보

3 ERROR-01 쿼리구성 에러(관리자에게 문의)

4 ERROR-02 통신에러(관리자에게 문의)

5 ERROR-03 검색결과 에러(관리자에게 문의)

- 7 -

2.2. 상세정보요청

한국고전적종합목록(KORCIS) 소장 자료에 대한 서지정보와 소장도서관 정보를 제공합니다.

2.2.1. 요청 URL (request url)

https://www.nl.go.kr/korcis/openApi/open.php?요청변수=값


NO 요청변수 값 설명

1 rec_key Integer(필수) 고유키


출력 필드 중 4~11번, 26~27번 필드는 값이 존재하는 경우에만 출력됩니다.



2 BIBINFO 서지항목(레코드 1건)

3 TITLE_INFO String 표제책임표시사항

4 EDITION_INFO String 판사항

5 CARTOGRAPHIC_INFO String 자료특성사항

6 PUBLISH_INFO String 발행사항

7 FORM_INFO String 형태사항

8 SERIES_INFO String 총서사항

9 NOTE_INFO String 서지 주기사항

10 STANDARD_INFO String 표준번호/부호

11 CLASSFY_INFO String 분류기호

12 CONTENTS_YN String 목차유무

- 8 -

13 ABSTRACTS_YN String 초록유무

14 COVER_YN String 표지유무

15 UB_CONTROL_NO String UB제어번호 : KORCIS 제어번호

16 ORIGINAL_YN String 원문유무

17 COPYRIGHT_YN String 저작권유무

18 LOCAL_CONTROL_NO String 로컬제어번호

19 ISBN String ISBN

20 PRICE_INFO String 가격

21 HOLDINFO 소장정보 컨테이너(레코드수만큼 반복)


23 LOCAL String

소장도서관 지역 정보

11(서울),21(부산),22(대구),23(인천),

24(광주),25(대전),26(부산광역시),

27(대구광역시),28(인천광역시),

29(광주광역시),30(대전광역시),

31(울산),41(경기),42(강원),43(충북),

44(충남),45(전북),46(전남),47(경북),

48(경남),49(제주)

24 LIB_CODE Integer 소장도서관 부호

25 LIB_NAME String 소장도서관 이름

26 CALL_NO String 서지 청구기호

27 START_VOL String 서지 시작 권호

28 ORIGINAL_YN String 원문유무

샘플 URL : https://www.nl.go.kr/korcis/openApi/open.php?rec_key=101147081

- 9 -








- 10 -

2.3. 원문자료검색

2.3.1. 검색

한국고전적종합목록(KORCIS)의 자료 중 원문이 있는 자료를 조회할 수 있는 기능을 제공합니다.

2.3.2. 요청 URL(request url)

https://www.nl.go.kr/korcis/openApi/openOrigin.php?요청변수=값


NO 변수명 값 설명

1 page Integer(필수) 페이지

2 search_field1 String(필수)

검색조건 1

전체: total_field


저자: author

발행자/대학명 : publisher

3 value1 String(필수) 검색어 1



검색조건 2


저자: author





검색조건 3


저자: author




https://www.nl.go.kr/korcis/openApi/openOrigin.php

https://www.nl.go.kr/korcis/openApi/openOrigin.php

- 11 -

11 search_field4 String 검색조건 4

12 value4 String

검색어 4


저자: author




검색조건 5


저자: author



16 gubun1 String

표준부호

ISBN: st_code

ISSN: st_issn

CODEN: st_coden

STRN(표준기술보고서번호): st_strn

RNSTRN(보고서번호): st_rnstrn

국가서지번호: st_cbn

저작권등록번호: st_can

17 code1 String 표준부호 값

18 gubun2 String

분류기호

KDC(한국십진분류법): kdc_class

KDCP(한국십진분류표-박봉석편): kdcp_class

DDC(듀이십진분류법): ddc_class

CEC(조선총독부신서부분류표): cec_class

CWC(조선총독부 양서부분류표): cwc_class

COC(조선총독부고서부분류표) : coc_class

19 code2 String 분류기호 값

20 start_year Integer 발행년도 시작

21 end_year Integer 발행년도 끝

- 12 -

22 maxCount String 최대검색건수

23 sort_ksj String 정렬조건

24 hanja_trans String (null / Y) 한자한글변환

25 per_page Integer(필수) 쪽당출력건수 (기본 10건)

- 13 -




2 LINK String KORCIS 홈페이지 링크

3 TOTAL Integer 검색건수

4 RECORD Integer 검색 결과 컨테이너(레코드 수만큼 반복)


6 TITLE String 서명

7 AUTHOR String 저자

8 PUBLISHER String 발행자

9 PUBYEAR String 발행년도

10 TYPE String 자료유형

11 CONTENTS String 목차여부

12 LIB_NAME String 도서관명

13 LIB_CODE Integer 도서관부호

14 REC_KEY Integer 서지정보 키

샘플 URL : ‘김해김씨’ 검색

https://www.nl.go.kr/korcis/openApi/openOrigin.php?page=1&search_field1=total_field&a

nd_or_not1=NOT&value1=%EA%B9%80%ED%95%B4%EA%B9%80%EC%94%A8&maxCoun

t=10 00&per_page=10

- 14 -








- 15 -

3. 사용 예시

3.1. 간략 검색

1) 자료 검색 Open API 호출 : 검색어 ‘김해김씨’

https://www.nl.go.kr/korcis/openApi/open.php?page=1&search_field1=total_field&and_or_

no t1=NOT&value1=%EA%B9%80%ED%95%B4%EA%B9%80%EC%94%A8&maxCount=10

00&per_page=10

※ URL은 반드시 인코딩해야 함

2) 자료검색 Open API 호출 결과

- 16 -

3) 홈페이지 검색 결과와 비교

4) 자료 검색 결과에서 1번째 자료 상세정보 API 호출

https://www.nl.go.kr/korcis/openApi/open.php?rec_key=101147081

- 서명: 金海金氏密直公派家乘譜

- rec_key : 101147081

- 17 -

5) 상세정보 API 호출 결과

- 18 -

6) 홈페이지 상세보기 결과

- 19 -

3.2. 원문 검색

1) 자료 검색 Open API 호출 : 검색어 ‘김해김씨’

https://www.nl.go.kr/korcis/openApi/openOrigin.php?page=1&search_field1=total_field&a

nd_or_not1=NOT&value1=%EA%B9%80%ED%95%B4%EA%B9%80%EC%94%A8&maxCoun

t=1000&per_page=10

※ URL은 반드시 인코딩해야 함

2) 상세정보 API 호출 결과

KORCIS Open API 가이드 - nl.go.kr · 2 TOTAL 검색건수 3 RECORD 검색 결과...

Documents

Transcript of KORCIS Open API 가이드 - nl.go.kr · 2 TOTAL 검색건수 3 RECORD 검색 결과...