검색 API

검색 API를 사용하시려면 키 등록·관리 페이지에서 API키를 발급 받으시기 바랍니다.
제목 뿐만 아니라 저자, 출판사, 카테고리별 검색 등 다양한 옵션이 제공되는 DBpia Open API를 이용해
나만의 학술정보 사이트를 만들어 보세요.

1. 요청 URL (request url)
http://api.dbpia.co.kr/v2/search/search.xml
2. 기본 요청 변수
간단한 통합검색창 하나로 검색 API를 사용할 수 있습니다.

요청변수

설명

key

string(필수)

발급받은 API 키를 입력합니다.

target

string(필수) : se

검색 API 서비스를 위해서는 무조건 입력해야 합니다.

searchall

string(필수)

검색하고자 하는 단어를 입력합니다.

3. 상세검색 요청변수
검색 API로 상세검색을 구현하기 위한 요청변수입니다.

요청변수

설명

key

string(필수)

발급받은 API 키를 입력합니다.

target

string(필수) : se_adv

상세검색을 위해서는 무조건 se_adv를 입력해야 합니다.

searchall

string

검색하고자 하는 단어를 입력합니다.

searchauthor

string

저자명을 검색할 때 입력합니다.

searchbook

string

간행물명을 검색할 때 입력합니다.

searchpublisher

string

발행기관명을 검색할 때 입력합니다.

itype

integer

자료유형별로 검색할 때 입력합니다.
1=학술저널 | 2=학술대회자료 | 3=전문잡지 | 4=연구보고서
※ 요청변수 itype과 collection은 둘 중 하나만 사용해야 합니다. 두 요청변수를 동시에 사용할 수 없습니다.

collection

integer

데이터베이스별로 검색할 때 입력합니다.
dbpia=DBpia 학술논문 | krpia=KRpia 웹DB
| bookrail=BookRail 전자책
※ 요청변수 itype과 collection은 둘 중 하나만 사용해야 합니다. 두 요청변수를 동시에 사용할 수 없습니다.

category

integer

주제분류별로 검색할 때 입력합니다.
1=인문학 | 2=사회과학 | 3=자연과학 | 4=공학 | 5=의약학 6=농수해양 | 7=예술체육 | 8=복합학 | 9=교양

pyear

integer

발행연도 지정
1=최근1년 | 2=최근3년 | 3=발행연도 직접 지정
※ pyear=3으로 지정한 후 발행연도와 시작연도를 모두 입력해야 합니다. (미입력 시 오류발생)
예) pyear=3&pyear_start=2000&pyear_end=2013

pyear_start

integer

발행년 시작연도
발행연도를 지정하여 검색할 때 입력합니다.

pyear_end

integer

발행년 종료연도
발행연도를 지정하여 검색할 때 입력합니다.

4. 필터 요청변수
필터 요청변수를 사용하면 원하는 데이터만 검색결과로 가져올 수 있습니다. 필터로 사용되는 요청변수는 다음과 같습니다.

요청변수

설명

freeyn

string

무료로 제공되는 콘텐츠를 포함시킬 것인지 지정합니다.
yes (기본값) : 무료 콘텐츠 포함
no (옵션) : 무료 콘텐츠 제외

priceyn

string

검색결과에 가격을 포함시킬 것인지 지정합니다.
yes(기본값) : 가격을 표시
no (옵션) : 가격을 표시하지 않음

5. 결과 페이지 구성 및 정렬
검색 API에 의한 검색결과 출력건수와 정렬방식을 지정합니다.

요청변수

설명

pagecount

integer

1 페이지당 검색결과 건수
이 요청변수를 지정하지 않으면 1페이지당 20건씩 검색결과를 가져옵니다.

pagenumber

integer

페이지 번호
이 요청변수를 지정하지 않으면 첫번째 페이지의 검색결과를 가져옵니다.

sorttype

integer

정렬유형
이 요청변수를 지정하지 않으면 유사도순으로 검색결과를 가져옵니다.
1=유사도순 | 2=발행일순 | 3=인기도순

sortorder

string

정렬순서
정렬유형과 함께 지정해야 합니다.
※ 발행일순과 제목순만 내림차순을 지원합니다. 유사도순과 인기도순은 정렬순서를 지정할 수 없습니다.
asc=오름차순 | desc=내림차순

6. 출력 결과 필드
6.1 출력 요약정보

필드

설명

keyword

string

검색어
검색어가 2개 이상일 경우에는 쉼표(,)로 구분하여 출력됩니다.

totalcount

integer

전체 검색결과수

pagecount

integer

1페이지당 검색결과수

pagenumber

integer

페이지 번호

sort

string

정렬방식

6.2 검색결과 건(item)별 출력정보

필드

설명

ctype

string

콘텐츠 유형
series=시리즈 | book=간행물 | db=데이터베이스
article =논문 | chapter=챕터 | record=항목
public=첫단추(논문)

title

string

제목
콘텐츠 유형에 따라 시리즈제목, 간행물제목, 데이터베이스명, 논문제목, 챕터제목, 항목명 등이 됩니다.

authors

-

저자명들
여러명의 저자를 child element인 author로 구분합니다.

author

-

하위요소
order = 저자순서, url=식별된 저자의 url, name=저자명

publisher

-

하위요소
url = 발행기관 url, name = 발행기관명

publication

-

간행물명
콘텐츠 유형이 논문, 챕터, 항목일 경우에만 표시됩니다.
하위요소
url = 간행물 url, name = 간행물명

info_reg

Y | N

등재정보
콘텐츠 유형이 간행물일 때만 표시됩니다.

info_update

Y | N

업데이트 여부
콘텐츠 유형이 간행물일 경우에만 표시됩니다.

issue

-

권호
하위요소.
range = 권호범위(콘텐츠 유형이 간행물일 경우에만 표시됩니다.)
name = 권호명(콘텐츠 유형이 논문일 경우에만 표시됩니다.)
num = 권(호) (콘텐츠 유형이 논문일 경우에만 표시됩니다.)
yymm = 발행연월(전자저널 간행물의 경우에는 표시되지 않습니다.)

pages

string

페이지
시작페이지~끝페이지(총페이지수)로 구성되어 있습니다.
콘텐츠 유형이 논문일 경우에만 표시됩니다.

price_yn

Y | N

무료, 유료 여부

price

string

가격

preview_yn

Y | N

미리보기 여부

preview

string

미리보기 링크

link_url

string

상세정보 링크

link_api

string

비즈니스 API 링크
논문에만 표시됩니다.

dreg_name

string

등재정보

8. 에러 메시지

번호

에러 메시지

설명

E0001

Unregistered key

등록되지 않은 키입니다.

E0002

Key necessary

요청변수중 키가 누락되었습니다.

E0003

Invalid target

target이 누락되었거나 잘못 지정되었습니다. 알 수 없는 서비스입니다.

E0004

Invalid version

API 버전 오류

E0005

Incorrect itype and collection

자료유형과 출처구분은 하나만 쓸 수 있습니다.

E0006

Incorrect itype

자료유형을 잘못 지정하였습니다.

E0007

Incorrect collection

데이터베이스를 잘못 지정하였습니다.

E0008

Invalid year type

연도는 숫자로 지정해야 합니다.

E0009

Incorrect year value

시작연도와 종료연도 중 하나가 누락되었습니다.

E0010

Keyword necessary

검색어는 필수입니다. 전체, 저자명, 간행물명, 발행기관명중 최소한 하나는 입력되어야 합니다.

E0011

Incorrect query request

기타 잘못된 쿼리 요청

E0012

Invalid key

사용할 수 없는 키입니다.

E0013

Incorrect key and os

키와 OS가 등록 내용과 맞지 않습니다.

E0014

Unregistered IP Address

등록되지 않은 IP주소입니다.

E0015

Service call timeout

서비스 시간이 초과되었습니다.

E0016

No result

검색결과가 없습니다.

E0017

Query request over limit

쿼리 요청 제한을 초과하였습니다.

E0018

Undefined Error

정의되지 않은 오류가 발생하였습니다.

E0000

System error

시스템 에러

top

TOP