1. 한국학종합정보서비스 Open API
한국학종합정보서비스(http://rinks.aks.ac.kr)는 한국민족문화대백과사전, 한국향토문화전자대전, 한국역대인물종합정보시스템, 조선왕조실록사전, 한국학전자도서관 등 한국학중앙연구원에서 서비스되고 있는 정보 시스템들을 통합 검색할 수 있는 ‘한국학중앙연구원 정보포털’ 시스템입니다. ‘한국학종합정보서비스 Open API’를 이용하면 한국학종합정보서비스에 통합된 콘텐츠를 검색하여 필요한 목록과 상세정보를 제공받을 수 있습니다.
2. 이용방법
1) 한국학종합정보서비스 Open API를 이용하기 위해서는 인증키를 발급 받으셔야 합니다.
2) 인증키 신청은 ‘한국학종합정보서비스 Open API 이용신청서’를 작성하여
‘tmt21@aks.ac.kr’로 보내주시면 인증키를 발급해 드립니다.
▶ 한국학종합정보서비스 Open API 이용안내
▶ 한국학종합정보서비스 Open API 이용신청서 (doc)
▶ 한국학종합정보서비스 Open API 이용신청서 (hwp)
3. 자료 검색 요청URL (예시)
- 검색어 ‘영조’, 검색 영역 ‘전체’:
http://openapi.aks.ac.kr/request?key=[발급받은 인증키]&pageNo=1&pageSize=10&search=%EC%98%81%EC%A1%B0&category=%EC%A0%84%EC%B2%B4
4.요청 메시지 명세
변수명 | 설명 | 항목구분 | 변수값 |
---|---|---|---|
key | 인증키 | 필수 | |
pageNo | 페이지 번호 | 선택 | (기본값: 1) |
pageSize | 페이지당 출력 건수 | 선택 | (기본값: 10) |
search | 검색어 | 필수 | |
category | 검색 영역 | 선택 | 전체 사전 고문헌 한국학전자도서관 학술연구자료 출판도서 멀티미디어 (기본값: 전체) |
※ key, search, category의 변수값은 UTF-8로 인코딩 된 값이어야 함.
※ category는 “OR” 검색을 지원함.
(예시) category=사전|고문헌
→ category=%EC%82%AC%EC%A0%84%7C%EA%B3%A0%EB%AC%B8%ED%97%8C
5. 응답 메시지 명세
항목명 | 설명 | 비고 |
---|---|---|
total | 검색 결과 전체 건수 | |
pageNo | 페이지 번호 | |
pageSize | 페이지당 출력 건수 | |
category | 검색 영역 | |
search | 검색어 | |
record - item -name -value | 목록 구성 정보 항목명 값 | 반복 |
6. 응답 XML 형식 (예시)
<?xmlversion="1.0" encoding="UTF-8" standalone="yes"?> <response> <record> <item> <name>자료명</name> <value>이재순 소장 고문서</value> </item> <item> <name>섹션</name> <value>사전</value> </item> <item> <name>출처</name> <value>한국향토문화전자대전|하동문화대전</value> </item> <item> <name>URL</name> <value>http://rinks.aks.ac.kr/OpenAPIRedirect.aspx?sCode=GC&sId=GC03401748</value> </item> <item> <name>요약정보</name> <value>경상남도 하동군 이재순이 소장하고 있는 조선 후기 고문서</value> </item> </record> ︙ <total>690</total> </response> |
7. 오류 메시지
오류번호 | 메시지 | 내용 |
---|---|---|
000 | SYSTEM ERROR | 시스템 오류 |
001 | SEARCH ERROR | 검색서버 오류 |
100 | INVALID KEY | 유효하지 않은 인증키 |
101 | DEADLINE HAS EXPIRED ERROR | 기한 만료된 인증키 |
200 | REQUIRED PARAMETER ERROR | 필수 파라미터 입력값 오류 |
201 | INVALID PARAMETER ERROR | 파라미터 입력값 오류 |
900 | UNKNOWN ERROR | 기타 오류 |