> OpenAPI

외규장각 의궤 OpenAPI

• 국립중앙박물관 외규장각 의궤 데이터를 서비스할 수 있습니다.
• API를 사용하기 위해서는 '애플리케이션 등록'을 통해 사용할 수 있습니다.
• 애플리케이션 등록: 등록하기

1. 신청인은 발급 받은 인증키를 타인에게 제공, 공개하거나 공유할 수 없으며 발급 받은 본인에 한하여 이를 사용할 수 있습니다.
2. 신청인은 서비스를 이용한 결과를 다른 정보와 혼합하지 않고 독립적으로 노출하여야 하며 출처를 명시해야 합니다.
3. 신청인은 서비스를 이용한 웹서비스나 독립 프로그램을 제작함에 있어 저작권 위반과 같은 불법적인 내용을 포함하거나 타 정보와 결합 또는 연계하여 구성하지 않아야
합니다.
4. 신청인은 아래 각 조건을 모두 충족하는 경우에 한하여 서비스를 이용할 수 있으며, 조건에 위반되는 경우 신청인의 서비스 이용을 중단시킬 수 있습니다.
a. 1일 기준 500회 호출 이하로 사용하는 경우
b. 비상업적 목적으로 사용하는 경우
c. 기타 본원이 이용을 제한하거나 금지하지 않는 경우

기본정보

지원하는 타입

  • • XML 형태로 서비스를 제공합니다.
  • • utf-8 인코딩을 사용합니다.

서비스 이용

기본사항

Service API명

외규장각 의궤서비스

API 호출
결과 타입

XML

일일사용량

5000회

호출방법

HTTP

API설명

외규장각 의궤 정보를 제공합니다.

메세지 설명 및 주의사항

Request에 아이디정보가 없습니다.

파라미터에 id가 빠져있을 때의 메세지입니다.

Request에 검색어정보가 없습니다.

파라미터에 keyword 정보가 빠져있을 때의 메세지입니다.

아이디가 없거나 사용중지 중입니다.

파라미터로 넘어온 아이디가 없거나 사용중지 중입니다. 관리자에게 문의하세요.

하루 사용량 5천건을 초과했습니다.

하루 5천건 요청을 초과했습니다.

주의사항 : 파라미터로 id는 필수이며, 등록할 때의 아이디를 입력해야 합니다.(id=XXXX)

Request URL

URL Method
http://uigwe.museum.go.kr/openapi/getData GET

Request Parameters

이름 type 설명
datatype String 데이터종류 : haeje(해제), dosul(도설), banchado(반차도), content(의궤본문), seoji(서지)
keyword String 검색어
start String 가져올 시작 Inde(기본값:1)
end String 가져올 마지막 Inde(기본값:1)

Response Fields

결과요소 설명
uigwe element(필수) 검색 결과물의 xml 최상의 root 요소.
uigwe/count string(필수) 질의에 대한 전체 검색 결과 수.
uigwe/datatype string(필수) 데이터 종류.
uigwe/keyword string(필수) 검색어.
uigwe/item element 반복되는 아이템.
item/kname string 서지: 서명.
item/kid string 서지: 외규번호.
item/productpyear string 서지: 간행년도.
item/sclassify_kind string 서지: 주제분류.
item/oclassify_kind string 서지: 오례분류.
item/rclassify string 서지: 왕대분류.
item/usage string 서지: 용법.
item/kname string 해제: 서명.
item/content string 해제: 내용.
item/kname string 도설: 서명.
item/sclassify_kind string 도설: 주제분류.
item/oclassify_kind string 도설: 오례분류.
item/rclassify string 도설: 왕대분류.
item/classify_name string 도설: 용도분류.
item/content string 도설: 도설해제.
item/dosulname string 도설: 도설명.
item/dosulyear string 도설: 연도.
item/kname string 반차도: 서명.
item/pyear string 반차도: 간행년도.
item/sclassify_kind string 반차도: 주제분류.
item/oclassify_kind string 반차도: 오례분류.
item/rclassify string 반차도: 왕대분류.
item/content string 반차도: 반차도 해제.
item/kname string 의궤본문: 서명.
item/kid string 의궤본문: 유물번호.
item/title string 의궤본문: 제목.
item/level1_title string 의궤본문: 1레벨 제목.
item/level2_title string 의궤본문: 2레벨 제목.
item/level1_content string 의궤본문: 1레벨 내용.
item/level2_content string 의궤본문: 2레벨 내용.

Respones Sample Code(인조로 검색한 경우)