동북아역사넷

상세검색 공유하기 모바일 메뉴 검색 공유
닫기
리스트

OpenAPI

사료라이브러리 열기
동북아역사넷에서는 국가DB사업으로 구축된 동북아역사자료DB를 개인, 기관이 자유롭게 이용할 수 있도록 검색OpenAPI를 제공합니다.검색 OpenAPI의 이용을 위해 사용자 식별 Key를 발급하고 있습니다. 아래의 신청양식을 작성하시고 사용자 식별 Key를 인증받으신 후, 아래의 사용 안내에 따라 검색 OpenAPI를 사용하시기 바랍니다.
신청시 입력한 사용목적 이외에 OpenAPI사용을 금하며, 식별 Key를 타인에게 양도할 수 없습니다.
*OpenAPI는 플랫폼으로서의 "웹" 이라는 특징을 기술적으로 구현한 대표적인 Web 2.0 기술입니다.
하나의 웹 사이트에서 사이트가 가진 기능을 이용할 수 있도록 공개한 프로그래밍 인터페이스를 OpenAPI라고 합니다.

동북아역사자료 검색 OpenAPI 사용 Key 신청

사용기관
이용사이트 URL
이메일

요청 URL (통합 검색 API)

http://contents.nahf.or.kr/openapi/search/integrate

요청 변수

요청 변수 (통합 검색 API)
요쳥변수 타입(필수여부) 설명
key string(필수) OpenAPI 신청 시 발급받은 인증키를 입력합니다.
searchKeyword string(필수) 검색어를 입력합니다

검색 결과(통합검색-JSON)

* 검색결과는 JSON 형식으로 반환됩니다.

검색 결과(통합검색-JSON)
변수 타입 설명
returnCode integer 검색 수행 성공 실패 유무
* 1 : 검색 수행 성공
* 2 : 분류되지 않은 오류로 인한 실패 ( 관리자에게 문의를 해야되는 오류 )
* 100 : 인증키 누락
* 101 : 미인증 발급키 사용으로 인한 에러
* 200 : 검색 키워드 누락
* 201 : 필수 파라미터 누락
* 202 : 상세 API 호출 시 배열 타입의 파라미터가 데이터누락, 오탈자, 개수 불일치 등으로 발생하는 에러
* 300 : 검색엔진 접근 에러 ( 반환되는 Error 코드를 관리자에게 문의 )
* 301 : 상세 API 파라미터 중 searchKeywordType 의 코드가 올바르지 않을 경우 발생하는 에러
* 302 : 검색엔진과 관련된 파라미터 누락으로 발생하는 에러 ( 관리자에게 문의 )
returnDescription string 검색 수행 메시지(오류 상태 메시지)
payload Object
"payload":{
      "resultCount":결과 총 건 수,
      "resultList":[  
         {  
            "menuCode": 카테고리 코드,
            "totalCount": 카테고리 검색 건 수,
            "menuList":[  
               {  
                  "codeName": 매뉴명,
                  "codeId": 메뉴 코드,
                  "totalCount":메뉴 검색 건 수,
                  "itemList":[  
                     {  
                        "itemId": 아이템ID,
                        "itemName": 아이템명,
                        "category": 카테고리코드,
                        "setId": 검색엔진 결과셋ID,
                        "totalCount": 아이템 검색 건 수
                     }, ...]
                }, ...]
            }, 
          "siteUrl":"http://localhost:8080/search/data.do?sort=levelId&dir=ASC&limit=10
                    &page=1&keywordTypeSelector=&searchKeywordType=BI
                    &searchKeywordMethod=EQ&searchKeyword=독도
                    &searchKeywordConjunction=AND"]}

요청 URL (상세 검색 API)

http://contents.nahf.or.kr/openapi/search/details

요청 변수

요청 변수 (상세 검색 API)
요쳥변수 타입(필수여부) 설명
key string(필수) OpenAPI 신청 시 발급받은 인증키를 입력합니다.
searchKeywordType Array(필수) 검색필드값을 입력합니다.
* BI : 전체 컬럼 대상 검색
* BI_TITLE : 제목 검색
* BI_DOC : 본문내용 검색
* B.DATE : 날짜 검색

각각의 검색필드 타입을 배열로 넘기기 위해서는 ','(콤마)로 구분하고, 배열의 크기가 2개 이상일 경우 배열 타입의 파라미터 크기는 모두 일치해야 합니다.
예) searchKeywordType=BI,BI_TITLE
searchKeywordMethod Array(필수) 비교연산자를 입력합니다
* EQ : 일치검색
* LIKE : 부분일치 검색(SQL 질의문 '%키워드%'와 같습니다)
* LIKE_LEFT : 부분일치 검색(SQL 질의문 '키워드%'와 같습니다)
* LIKE_RIGHT : 부분일치 검색(SQL 질의문 '%키워드'와 같습니다)

각각의 비교연산자를 배열로 넘기기 위해서는 ','(콤마)로 구분하고, 배열의 크기가 2개 이상일 경우 배열 타입의 파라미터 크기는 모두 일치해야 합니다.
예) searchKeywordMethod=EQ,LIKE
searchKeyword Array(필수) 검색어를 입력합니다

각각의 검색어를 배열로 넘기기 위해서는 ','(콤마)로 구분하고, 배열의 크기가 2개 이상일 경우 배열 타입의 파라미터 크기는 모두 일치해야 합니다.
예) searchKeyword=독도,우리땅
searchKeywordConjunction Array(필수) 질의문 간 논리연산자를 입력합니다.
(질의문이 하나인 경우에도 입력되어야합니다)
* AND : 질의문 조건 모두 참
* OR : 질의문 중 하나라도 참

각각의 논리연산자를 배열로 넘기기 위해서는 ','(콤마)로 구분하고, 배열의 크기가 2개 이상일 경우 배열 타입의 파라미터 크기는 모두 일치해야 합니다.
예) searchKeywordConjunction=AND,OR
setId String(필수) 통합검색API 검색 결과 중 setId 값을 입력합니다
itemId String(필수) 통합검색API 검색 결과 중 itemId 값을 입력합니다.
limit integer 검색 시 노출 시킬 결과의 건수
* 기본값 : 10
start integer 검색 시 가장 처음이 되는 기준 점 설정
* 기본값 : 0
* start=0&limit=10 일 경우 결과의 맨 첫 번째로부터 10건의 데이터가 리턴

검색 결과(통합검색-JSON)

* 검색결과는 JSON 형식으로 반환됩니다.

검색 결과(통합검색-JSON)
변수 타입 설명
returnCode integer 검색 수행 성공 실패 유무
* 1 : 검색 수행 성공
* 2 : 분류되지 않은 오류로 인한 실패 ( 관리자에게 문의를 해야되는 오류 )
* 100 : 인증키 누락
* 101 : 미인증 발급키 사용으로 인한 에러
* 200 : 검색 키워드 누락
* 201 : 필수 파라미터 누락
* 202 : 상세 API 호출 시 배열 타입의 파라미터가 데이터누락, 오탈자, 개수 불일치 등으로 발생하는 에러
* 300 : 검색엔진 접근 에러 ( 반환되는 Error 코드를 관리자에게 문의 )
* 301 : 상세 API 파라미터 중 searchKeywordType 의 코드가 올바르지 않을 경우 발생하는 에러
* 302 : 검색엔진과 관련된 파라미터 누락으로 발생하는 에러 ( 관리자에게 문의 )
returnDescription string 검색 수행 메시지(오류 상태 메시지)
payload Object
   "payload":{  
      "setId": 검색엔진 결과셋ID,
      "limit": 설정한 limit 값,
      "start":설정한 시작점 값,
      "category": 카테고리,
      "itemId": itemID,
      "itemName": item명,
      "description": 카테고리 설명,
      "resultCount": 검색 결과 전체 건 수,
      "resultList":[  
         {  
            "author":"장순순",
            "levelText":"... 강치)라는 바다 동물이 살고 있다는 사실도 기술하고 있다. 
                        그리고 고려시대에 울릉도 도주가 고려에 조공한 사실을 상세하게 언급하며, 
                        조선 성종대 삼봉도(三峯島; 독도)를 
                         확인하기...",
            "levelId":"sd.d_0069_0020",
            "mainTitle":"(諸島) 鬱陵島",
            "levelId1":"sd.d_0069",
            "mainTitle1":"文獻攷略",
            "levelId2":"sd.d_0069_0020",
            "mainTitle2":"(諸島) 鬱陵島",
            "levelId3":"",
            "mainTitle3":"",
            "levelId4":"",
            "mainTitle4":"",
            "levelId5":"",
            "mainTitle5":"",
            "levelId6":"",
            "mainTitle6":"",
            "levelId7":"",
            "mainTitle7":"",
            "dates":"9999-99-99",
            "dateOccured":"9999-99-99",
            "siteUrl":"http://contents.nahf.or.kr/search/itemResult.do?levelId=sd.d_0069_0020
                        &setId=2190&position=0"
         }, ...]
     }