open API
OAK Open API
- OAK 오픈API는 OAK 포털의 검색 서비스 플랫폼을 외부에 공개하여, 여러분의 웹 사이트에서 이를 활용한 고부가가치 정보서비스를 개발할 수 있도록 지원하는 오픈서비스입니다.
목적
- OAK 오픈API는 REST 프로토콜을 사용하여 다양한 매쉬업 서비스의 개발이 용이합니다.
특징
- OAK의 학술정보를 활용하여 고부가 서비스를 개발하고자 하는 도서관
- 비영리 목적으로 OAK의 학술정보를 이용하고자 하는 개발자
활용대상
Open API 신청
* 신청기관의 정보를 입력해주십시요.
* 
는 필수입력 항목입니다.
매뉴얼 다운로드
Open API 개발자 매뉴얼과 XML스키마입니다. 스키마를 함께 참고하시면 Open API를 좀더 쉽게 활용하실 수 있습니다.
Open API 2.0 매뉴얼
Open API 2.0 파일형식: PDF 내려받기
Open API 2.0 XML Return Format
검색 API 활용
주요기능
Oak Portal에서 서비스 되고 있는 학술논문에 대한 검색 결과(논문명, 출판사, 저자 등)를 제공합니다.
활용예제
아래와 같이 OpenAPI 프로토콜 입력 규칙에 따라 베이스URL, 타깃 DB, 질문식, 검색항목 등을 조합하여 OpenAPI를 호출하면 검색결과를 XML로 제공합니다. (푸른색은 필수입력 항목입니다.)
http://www.oak.go.kr:80/openapi?keyset=EB1AB0540642B6AE407B03C99F6B29A3&keyword=data&dataType=arti&sortby=titl&displayCount=20
활용분야
기관에서 제공하고 있지 않은 콘텐츠에 대한 검색서비스를 추가하거나 아래와 같이 특정분야 정보만을 선별하여 주제별서비스 등을 제공할 수 있습니다.
요청변수
| Parameter | 설명 | value | 설명 | 비고 |
|---|---|---|---|---|
| keySet | 인증키 | |||
| dataType | 자료유형 | all | 전체 | |
| arti | 논문 | |||
| thes | 학위논문 | |||
| book | 단행본 | |||
| dset | 데이터셋 | |||
| pate | 특허 | |||
| repo | 보고서 | |||
| mult | 멀티미디어 | |||
| pres | 프레젠테이션 | |||
| etc | 기타 | |||
| searchField | 검색항목 | titl | 제목 | |
| keyw | 키워드 | |||
| abst | 초록 | |||
| tabl | 목차 | |||
| displayCount | 검색결과 출력건수 | 기본값 10, 최대 100 | ||
| currentPage | 요청 페이지 | 기본 1페이지 | ||
| sortby | 정렬항목 | date | 발행일 | |
| titl | 제목 | |||
| sortType | 정렬형태 | asc | 오름차순 | |
| desc | 내림차순 | |||
| keyword | 검색 질의어 | URL(한글)은 반드시 인코딩해야 함 |
출력결과 필드
| 필드 | 설명 |
|---|---|
| totalCount | 검색결과 건수 |
| dataType | 자료유형 |
| searchField | 검색항목 |
| displayCount | 검색결과 출력건수 |
| currentPage | 페이지 번호 |
| sortby | 정렬항목 |
| sortType | 정렬형태 |
| keyword | 검색질의어 |
| 필드 | 설명 |
|---|---|
| irType | 기관유형 |
| title | 제목 |
| authors | 저자 |
| issueDate | 출판연도 |
| abstract | 초록 |
| publisher | 출판사 |
| url | 접근 URL |
에러 메시지
오류 발생시 오류코드에 해당하는 조치방법을 참조하여 문제를 해결하실 수 있으며, 문제가 지속되면 OpenAPI
담당자에게 연락하시기 바랍니다.
| 에러코드 | 에러 메시지 | 조치방법 |
|---|---|---|
| E0001 | 필수항목 미입력 오류 | 오류 메시지에 표시된 필수항목을 입력하십시오. |
| E0003 | 인증받지 않은 Key | 인증 Key가 아닙니다. OpenAPI Key를 발급받으시기 바랍니다. |
| E0006 | 승인 대기중인 Key | 미승인 Key입니다. 관리자의 승인이 필요합니다. |
