Open API
1. DBpia Open API 개요
1.1 DBpia Open API 란?
DBpia 서비스를 외부에서 이용할 수 있도록 공개한 개발자 인터페이스로, 6가지 종류의 API를 제공하고 있습니다.
- (1) 검색 API
- (2) 인기논문 API
- (3) 비즈니스 API
누리미디어 오픈 API 플랫폼 개발을 위해서는 회원 등록 후 API 키를 발급받아야 합니다. 검색 API 키를 발급받으면 모바일 API를 동시에 사용할 수 있지만 비즈니스 API는 별도의 키가 필요합니다.
1.2 DBpia Open API 종류
- (1) 검색 API
[검색 옵션]
-
기능
설명
-
질의어 검색
전체 통합검색 뿐만 아니라 저자명, 간행물명, 발행기관명을 검색할 수 있습니다.
또한 질의어, 저자명, 간행물명, 발행기관명을 조합한 상세검색 기능도 지원합니다.
예) ‘한국’이라는 질의어가 들어간 논문 중, ‘김누리’가 작성하고 ‘한국누리학회지’에 실린 논문을 보고 싶을 때
→ 큰 검색창에는 ‘한국’, 저자 검색창에는 ‘김누리’, 간행물 검색창에는 ‘한국누리학회지’를 입력하여 검색 가능합니다. -
주제분류 선택
질의어 검색시 특정 주제분류를 선택하여 그 주제분류에 해당되는 정보만 검색할 수 있습니다.
주제분류는 인문학, 사회과학, 자연과학, 공학, 의약학, 농수해양학, 예술체육, 복합학, 교양 중에서 선택할 수 있습니다. -
자료유형 선택
질의어 검색시 학술저널, 학술대회자료, 전문잡지, 연구보고서 등 자료유형을 선택하여 그 자료유형에 해당되는 정보만 검색할 수 있습니다.
-
발행연도 선택
질의어 검색시 발행연도를 설정하여 검색할 수 있습니다.
발행연도는 시작연도, 종료연도를 설정하거나, 최근 1년, 최근 3년 단위로 지정할 수도 있습니다.
[참고] 질의어는 필수 입력항목입니다. 따라서 주제분류, 자료유형, 발행연도 선택시 적어도 하나의 질의어는 입력되어야 합니다.
- (2) 인기논문 API
- (3) 비즈니스 API
2. API 사용방법
1.1 Open API 구동방식
누리미디어 Open API는 웹프로토콜(HTTP)로 호출되어 XML로 결과값을 전달합니다. 따라서 Open API를 사용하는 애플리케이션은 웹프로토콜을 이용하여 특정 URL로 요청을 전송하고, 서버로부터 전달되는 XML결과를 파싱해야 합니다. 예를 들어 검색 API에서 검색결과를 요청하는 Open API의 URL은 다음과 같습니다.
http://api.dbpia.co.kr/v2/search/search.xml?key=0000&target=se&searchall=library
위의 URL을 웹브라우저로 보면 다음과 같습니다.
1.2. 요청 URL
- http://api.dbpia.co.kr/v2/search/search.xml
1.3. 요청 변수
서버에 전송해야 하는 값으로, 오청 URL 뒤에 변수명과 값을 “name=value” 형식으로 명시하며 요청변수가 많으면 ‘&’로 구분합니다. 요청변수에는 반드시 명시해야 하는 기본 요청변수와 선택적 요청변수가 있습니다.
- 1.3.1. 기본 요청 변수
- 누리미디어 검색 Open API의 경우 다음 3가지 요청변수는 필수사항입니다.
기본 요청변수를 지정하지 않으면 다음과 같은 오류 메시지가 XML로 반환됩니다.
- 1.3.2. 선택 요청 변수
- Open API 호출시 전송화지 않으면 기본값이 사용되며 API는 문제없이 동작합니다. 선택 요청변수에는 다음과 같은 것들이 있습니다.
1.4. 예제
검색 API 에서 ‘library’라는 검색어로 사회과학 자료만 검색할 경우 호출 URL 구성은 다음과 같습니다.
이를 조합한 최종 URL은 다음과 같습니다.
http://api.dbpia.co.kr/v2/search/search.xml?key=0000&target=se&searchall=library&category=2
각각의 API에 대해서는 각 해당 페이지를 참고하십시오.
){kind=link}