본문 바로가기주메뉴 바로가기
OPEN API
  • 1. 한국민족문화대백과사전 OpenAPI 서비스 소개

    한국민족문화대백과사전 OpenAPI 서비스는 한국민족문화대백과사전을 보다 더 편리하게 사용할 수 있도록 개발자와 사용자들에게 공개된 검색 플랫폼입니다. 본 OpenAPI를 적용하면 다양한 서비스 및 어플리케이션에서 문화대백과사전을 자유롭게 이용하실 수 있습니다.

  • 2.한국민족문화대백과사전 OpenAPI 인증키 발급

    본 OpenAPI 서비스를 이용하기 위해서는 먼저 인증키를 발급받아야 합니다. 인증키가 없거나 올바르지 않은 경우에는 서비스 이용이 제한됩니다. 인증키는 사용자 당 한 개만 발급받을 수 있으며 서비스 요청은 하루에 25,000건으로 제한됩니다.

    위 신청서를 작성하여 encykorea@aks.ac.kr로 보내주시면 인증키를 발급해 드립니다.

    OpenAPI 서비스 이용 신청서

  • 3.한국민족문화대백과사전 OpenAPI 서비스 이용 안내
    • 3.1. 백과사전 검색
      • - 요청 URL
        http://encykorea.aks.ac.kr/OpenApi/Text/Search
      • - 요청 METHOD
        "POST" METHOD만 허용
      • - 검색 요청 변수
        요청 변수 타입 허용값 필수/선택 설명
        key string 16진수 32자리 필수 인증키
        query string, utf-8 - 필수 검색어
        display integer 10 ~ 100 선택 검색 당 출력 개수 (기본값: 10)
        start integer 1 ~ 1000 선택 검색 시작 페이지 (기본값: 1)
        result string xml 또는 json 선택 출력 형식 지정 (기본값: xml)
      • - 검색 결과 필드 (XML 형식)
        필드 타입 필수/선택 설명
        channel - 필수 검색 결과를 포괄하는 필드
        title string 필수 제목(고정값: 한국민족문화대백과사전 OpenAPI – 사전 검색)
        link string 필수 백과사전 URL(고정값: http://encykorea.aks.ac.kr)
        description string 필수 설명(고정값: 한국민족문화대백과사전 OpenAPI - 사전 검색 결과)
        lastBuildDate datetime 필수 검색 결과를 생성한 시간
        total integer 필수 색된 전체 항목 수
        start integer 필수 페이지
        display integer 필수 페이지 당 항목 수
        item - 필수 개별 검색 결과를 포괄하는 필드
        headword string 필수 항목명
        definition string 필수 항목 정의
        defSent string 필수 항목 정의 설명
        category - 필수 항목 분류를 포괄하는 필드
        field string 선택 분야
        types string 선택 유형
        era string 선택 시대
        link string 필수 사전 항목 보기 URL
      • - 검색 결과 예시 (XML)
        <?xml version="1.0" encoding="utf-8"?> <channel> <title>한국민족문화대백과사전OpenAPI - 사전검색</title> <link>http://encykorea.aks.ac.kr</link> <description>한국민족문화대백과사전OpenAPI - 사전검색결과</description> <lastBuildDate>2017-08-21 오전9:14:48</lastBuildDate> <total>115</total> <start>1</start> <display>3</display> <item> <headword>이순신</headword> <definition> <defSent>조선중기의명장.</defSent> </definition> <category> <fields> <field classA="역사" classB="조선시대사"/> </fields> <types> <인물> <성격>장군, 무신</성격> <성별>남</성별> <출생일>1545년(인종1)</출생일> <사망일>1598년(선조31)</사망일> <본관>덕수(德水)</본관> <저작>난중일기</저작> <경력>동구비보권관, 건원보권관, 사복시주부, 정읍현감, 전라좌도수군절도사</경력> <관련사건>임진왜란, 옥포대첩, 한산대첩, 명량해전, 노량해전</관련사건> </인물> </types> <era begin="조선" end="조선"/> </category> <link>http://encykorea.aks.ac.kr/Contents/Text/E0044900</link> </item> <item> <headword>이순신</headword> <definition> <defSent>조선중기의무신.</defSent> </definition> <category> <fields> <field classA="역사" classB="조선시대사"/> </fields> <types> <인물> <성격>무신</성격> <성별>남</성별> <출생일>1554년(명종9)</출생일> <사망일>1611년(광해군3)</사망일> <본관>전주(全州)</본관> <경력>온성판관, 의주판관, 전라도병마절도사, 첨지중추부사</경력> <관련사건>임진왜란, 노량해전</관련사건> </인물> </types> <era begin="조선" end="조선"/> </category> <link>http://encykorea.aks.ac.kr/Contents/Text/E0044901</link> </item> <item> <headword>이순신</headword> <definition> <defSent>1908년신채호(申采浩)가지은역사전기소설.</defSent> </definition> <category> <fields> <field classA="문학" classB="현대문학"/> </fields> <types/> <era begin="근대" end="근대"/> </category> <link>http://encykorea.aks.ac.kr/Contents/Text/E0044902</link> </item> </channel>
    • 3.2. 멀티미디어 검색
      • - 요청 URL
        http://encykorea.aks.ac.kr/OpenApi/Multimedia/Search
      • - 요청 METHOD
        "POST" METHOD만 허용
      • - 검색 요청 변수
        요청 변수 타입 허용값 필수/선택 설명
        key string 16진수 32자리 필수 인증키
        query string, utf-8 - 필수 검색어
        display integer 10 ~ 100 선택 검색 당 출력 개수 (기본값: 10)
        start integer 1 ~ 1000 선택 검색 시작 페이지 (기본값: 1)
        result string xml 또는 json 선택 출력 형식 지정 (기본값: xml)
      • - 검색 결과 필드 (XML 형식)
        필드 타입 필수/선택 설명
        channel - 필수 검색 결과를 포괄하는 필드
        title string 필수 제목(고정값: 한국민족문화대백과사전 OpenAPI – 사전 검색)
        link string 필수 백과사전 URL(고정값: http://encykorea.aks.ac.kr)
        description string 필수 설명(고정값: 한국민족문화대백과사전 OpenAPI - 사전 검색 결과)
        lastBuildDate datetime 필수 검색 결과를 생성한 시간
        total integer 필수 색된 전체 항목 수
        start integer 필수 페이지
        display integer 필수 페이지 당 항목 수
        item - 필수 개별 검색 결과를 포괄하는 필드
        title string 필수 멀티미디어 제목
        description string 선택 멀티미디어 설명
        link string 선택 시대
      • - 검색 결과 예시 (XML)
        <?xml version="1.0" encoding="utf-8"?> <channel> <title>한국민족문화대백과사전OpenAPI - 멀티미디어검색</title> <link>http://encykorea.aks.ac.kr</link> <description>한국민족문화대백과사전OpenAPI - 멀티미디어검색결과</description> <lastBuildDate>2017-08-21 오전9:09:11</lastBuildDate> <total>7</total> <start>1</start> <display>3</display> <item> <title>이순신난중일기및서간첩임진장초/ 임진장초</title> <description>『임진장초(壬辰狀草)』, 1책(81장), 46x3.5㎝, 국보제76호, 현충사소장. 이순신이임진왜란중조정에올린보고서[장계(狀啓)]를다른사람이옮겨적어놓은것이다.</description> <link>http://encykorea.aks.ac.kr/Contents/Multimedia/6e0e7d12-37b2-406a-b249-0d85b586a507</link> </item> <item> <title>남해관음포이충무공유적이락사</title> <description>경상남도남해군고현면차면리에이순신의우국충정을기리기위해조성한유허이다. 사적제232호</description> <link>http://encykorea.aks.ac.kr/Contents/Multimedia/b318e924-cb9b-4b58-9918-527ec8f9fa8e</link> </item> <item> <title>고하도이충무공유적</title> <description> 전남목포시원동에있는정유재란때충무공이순신이군진을설치하고성을쌓았던일원. 전라남도기념물제10호. 고하도는목포에서서남쪽으로2km쯤떨어진곳에자리한조그만섬으로이순신은명량대첩뒤에 이곳에서군량미를비축하고전력을재정비하면서108일간을주둔하였다. </description> <link>http://encykorea.aks.ac.kr/Contents/Multimedia/08aa426c-f26d-4b44-bbbc-a0fe1946089f</link> </item> </channel>
  • 4. 검색 에러 메시지
    에러 코드 에러 메시지 설명
    000 System Error 시스템 에러
    001 Incorrect query request 검색어 오류(누락 또는 글자가 아닌 것이 포함된 경우)
    002 Malformed encoding 검색어 인코딩 오류
    003 Invalid display value 잘못된 display 값
    004 Invalid start value 잘못된 start 값
    010 Your query request count is over the limit 요청 제한 수 초과
    011 Unregistered key 등록되지 않은 키
    012 Your key is temporary unavailable 일시적으로 사용 중지된 인증키
    • - 에러 메시지 예
      <?xml version="1.0" encoding="UTF-8"?> <error> <code>011</code> <message>Unregistered key</message> </error>