 |
이용안내 |
|
| KRM OpenAPI는 KRM의 인문/사회/예술분야의 다양한 연구논문 및 저역서 등의 데이터를 좀 더 쉽게 이용하실 수 있도록 검색서비스 플랫폼을 외부에 공개하는 개발자를 위한 인터페이스이며, KRM OpenAPI는 XML프로토콜을 사용하여 API를 개발하여 다양한 서비스 및 어플리케이션을 개발할 수 있도록 외부에 공유하는 프로그램입니다. |
|
 |
OpenAPI 기능 사용설명 |
|
KRM 인문/사회/예술분야의 논문, 저역서, 보고서,조사자료,학술논문, 고문서, 이미지, 동영상, 녹음자료, 웹사이트, 기사자료에
대한 목록정보 |
|
|
|
Open API 연계 기관 |
|
| 국회도서관 |
 |
창원대학교 |
|
| 순천대학교 도서관 |
|
국립무형유산원 |
|
| 에너지경제연구원 |
|
고려대학교 |
|
| 산업연구원 |
|
대구한의대학교 |
|
| 나사렛대학교 도서관 |
|
경기도365열린도서관 |
|
| 동명대학교 중앙도서관 |
|
가야대학교 분성도서관 |
|
| 한서대학교 연암도서관 |
|
단국대학교 퇴계기념중앙도서관 |
|
| 경기대학교 |
|
선문대학교 중앙도서관 |
|
| 한남대학교 |
|
광주여자대학교 |
|
| 충남대학교 |
|
경운대학교 |
|
| 군산대학교 중앙도서관 |
|
광주대학교 |
|
| 조선대학교 |
|
명지대학교 도서관 |
|
| 중앙대학교 중앙도서관 |
|
인천글로벌캠퍼스 |
|
| 국민연금공단 도서관 |
|
방송통신대학교 |
|
| 원광대학교 중앙도서관 |
|
숙명여자대학교 도서관 |
|
| KDI국제정책대학원 |
|
초당대학교 |
|
| 한양대학교 ERICA 학술정보관 |
|
한양대학교 백남학술정보관 |
|
| 경상대학교 |
|
충북대학교 |
|
| 울산대학교 |
|
순천향대학교 |
|
| 한국교원대학교도서관 |
|
남서울대학교 |
|
| 성결대학교 |
|
동신대학교 중앙도서관 |
|
| 한동대학교 |
|
금오공과대학교 도서관 |
|
| 한국교통대학교 |
|
인천대학교 |
|
| KC대학교 |
|
유원대학교 |
|
| |
|
OpenAPI 명 |
|
| 검색API : http://www.krm.or.kr/krmts/search/openAPI_krmSearch.html |
|
|
요청변수(request parameter) |
|
| 요청변수
| 변수명
| 변수유형
| 값범위 (UTF-8 인코딩)
| 필수
여부
| 설명
|
| sysid |
기관코드 |
String |
기관마다 부여하는 고정된
기관 고유코드값 |
Y |
인증을 위한 기관 고유 Key 값 |
| frbrDataTypeCd
|
검색
자료유형 |
String |
 All : 전체 유형 통합 검색
Research : 연구과제
ExpAll : 연구성과물 통합 검색
ResearchPaper : 논문
Volume : 단행본
Report : 보고서
Survey : 조사자료
AncientDocument : 고문서
Image : 이미지
Video : 동영상
Sound : 녹음자료
AncientBook : 고도서
WebSite : 웹사이트
Article : 기사자료
Text : 낱장자료 |
Y |
All 값인 경우 : 전체 자료 유형을
대상으로 검색
ExpAll 값인 경우 : 연구 과제를
제외한 전체 자료 유형을 대상으로
검색(2013.03.12 추가)
|
| keyword_field |
검색필드 |
String |
all : 전체 (기본값)
title : 서명
author : 저자
publisher : 출판사(기관)
subject : 주제어
contents : 초록 |
N |
Null 값인 경우 전체 필드(All)를
대상으로 검색 |
| keyword |
검색어 |
String |
검색하고자 하는 검색어 |
Y |
Null 값 불가 |
| date1 |
시작일 |
Integer |
YYYYMMDD |
N |
Null 값인 경우 전체 발행년을
대상으로 검색 (제약검색 자)
단, 연구과제 검색일 경우
'YYYY' 만 잘라서 사용 |
| date2 |
종료일 |
Integer |
YYYYMMDD |
N |
| sort_type |
결과
정렬필드 |
String |
score : 점수기준 (기본값)
title : 서명기준
date : 작성일
|
N |
Null 값인 경우 점수기준(score)을
기본값으로 사용 |
| sort |
결과
정렬방식 |
String |
asc : 오름차순 정렬 (기본값)
desc : 내림차순 정렬 |
N |
Null 값인 경우 오름차순 (asc)을
기본값으로 사용 |
currentPage
Number
|
현재
페이지
번호 |
Integer |
1(기본값) ~ |
N |
Null 값인 경우 1 |
| listPerPage |
페이지
결과건수 |
Integer |
10(기본값), 20, 30, 40, 50 ~ 300 |
N |
Null 값인 경우 10 |
| executeQuery |
결과내
재검색문 |
String |
검색질의문 |
N |
검색질의 생성문
(클라이언트쪽에서 임의 수정불가)
Null값이 아니면 결과내 재검색 |
| facet_field |
패싯필드 |
String |
year |
N |
응답결과에 요청한 패싯을 추가하여 응답
(현재는 년도 패싯인 year만 지정가능 패싯은 추후 계속 추가예정) |
|
|
|
출력 결과 필드(response field) |
|
| 항목
| 항목명
| 반복
유무
| 값
| 필수
유무
| 설명
|
| totalcount |
검색결과 건수 |
N |
Integer |
Y |
검색결과 총 건수 |
| expcount |
자료유형별
검색결과 건수 |
N |
String
research : 연구과제
volume : 단행본
report : 보고서
researchPapar : 논문
survey : 조사자료
image : 이미지
video : 동영상
sound : 녹음자료
ancientDocument : 고문서
ancientBook : 고도서
article : 기사자료
text : 낱장자료
webSite : 웹사이트
|
Y |
검색결과의 자료유형별
검색결과 건수
(2013.03.02 추가)
|
| Error |
오류코드 |
N |
String |
Y |
에러코드 |
| ErrorMessage |
오류내용 |
N |
String |
Y |
에러메시지 |
| executeQuery |
검색질의어 |
N |
String |
Y |
결과내 검색을 위한 검색질의문 |
| krm.type |
자료유형그룹 |
Y |
String |
Y |
자료유형 그룹 코드 |
| krm.key |
자료 키 |
Y |
String |
Y |
자료 키값으로 자료유형
(krm.stype와 같이 쓰임) |
| krm.stype |
자료유형 |
Y |
Research : 연구과제
ResearchPaper : 논문
Volume : 저역서
Report : 보고서
Survey : 조사자료
AncientDocument : 고문서
Image : 이미지
Video : 동영상
Sound : 녹음자료
AncientBook : 고도서
Article : 기사자료
Text : 낱장자료
WebSite : 웹사이트
|
Y |
자료유형 코드 |
| krm.researchTitle
|
과제명 |
Y |
String |
Y |
과제명 |
| krm.linkingEntry
|
과제번호 |
Y |
String |
Y |
|
| krm.title |
서명 |
Y |
String |
Y |
제목 |
| krm.author |
저자 |
Y |
String |
Y |
저자명 |
| krm.publisher |
출판사 |
Y |
String |
Y |
발행처 |
| krm.pubdate |
출판년 |
Y |
Integer (YYYY) |
Y |
발행년도 |
| krm.contents |
초록 |
Y |
String |
Y |
초록 |
| krm.url |
상세정보
Link URL |
Y |
String |
Y |
링크URL |
| facet |
패싯영역 |
N |
|
|
패싯영역
(2014.04.01 추가) |
| facet/year |
년도패싯 |
N |
|
|
년도패싯 |
| facet/year/item |
년도패싯/
아이템 |
Y |
|
|
년도패싯 아이템 |
facet/year/item/year
facet/year/item/count
facet/year/item/url
|
년도
건수
URL
|
|
String |
N |
패싯 아이템 정보 |
|
|
|
Open-API 이용방법
- 토대연구DB Open-API를 이용 하기 위해서는 기초학문자료센터 회원가입 후 이용이 가능.
- Open-API 사용 신청서 작성
- Open-API 신청 절차
- Open-API 신청서 작성 방법
- 토대연구DB > Open-API > Open-API 신청 메뉴에서 신청서 작성
- 개인정보 제공·이용 약관에 동의
- 공공정보활용약관에 동의.
- Open-API 신청 정보 입력.
관리자의 신청서 검토 후 이메일을 통한 인증키 통보.
발급된 인증키를 이용하여 Open-API를 호출하여 사용.
HOME > 알림마당 > OPEN-API > 이용안내
