본문 바로가기주메뉴 바로가기
닫기
Open API>Open API 사용신청

Open API

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

고대문화유산자료 검색 OpenAPI 사용 Key 신청

사용기관
이용사이트 URL
이메일
API 종류
자료 아이디 요청 결과 유형
        
요청 결과 포맷
API 신청

요청 URL

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

요청 변수

요청 변수
요쳥변수 설명
key string(필수) OpenAPI 신청 시 발급받은 인증키를 입력합니다.
searchKeywordType string(필수) 검색필드값을 입력합니다.
* BI : 전체 컬럼 대상 검색
* BI_TITLE : 제목 검색
* BI_DOC : 본문내용 검색
* levelId : 자료ID 검색
searchKeywordMethod string(필수) 비교연산자를 입력합니다
* EQ : 일치검색
* LIKE : 부분일치 검색(SQL 질의문 '%키워드%'와 같습니다)
* LIKE_LEFT : 부분일치 검색(SQL 질의문 '키워드%'와 같습니다)
* LIKE_RIGHT : 부분일치 검색(SQL 질의문 '%키워드'와 같습니다)
searchKeyword string(필수) 검색어를 입력합니다
searchKeywordConjunction string(필수) 질의문 간 논리연산자를 입력합니다.
(질의문이 하나인 경우에도 입력되어야합니다)
* AND : 질의문 조건 모두 참
* OR : 질의문 중 하나라도 참
* 예) 자료명이 '독도' 또는 '울릉도'인 검색시 매개변수 값은 다음과 같습니다
searchKeywordType=BI_TITLE searchKeywordMethod=EQ searchKeyword=독도 searchKeywordConjunction=OR
searchKeywordType=BI_TITLE searchKeywordMethod=EQ searchKeyword=울릉도 searchKeywordConjunction=AND
searchResultFormat string(필수) 결과유형을 입력합니다
* j : JSON
* x : XML
* t : TXT
* e : EXCEL

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

* 검색결과는 JSON 형식으로 반환됩니다. 파싱 및 이용방법은 페이지 하단의OpenApi활용 샘플을 참고하시기 바랍니다.

검색 결과(통합검색-JSON) 예시
변수 설명
success string 검색 수행 성공 실패 유무
* true : 검색 수행 성공
* false : 검색 수행 실패(message를 통해 실패원인을 확인할 수 있습니다)
message string 검색 수행 메시지
searchResult string
검색결과셋 Object
searchResult:[{
	groupId:	형태분류코드
	groupName:	형태분류명
	totalCount:	형태의 검색 건 수
	itemList:[{
		itemId:		아이템ID
		itemName:	아이템명
		setId:		검색엔진 결과셋ID
		count:		아이템 검색 건 수
	}, ...]
}, ...]

검색 테스트