OPEN API 이용안내
- 기억과 기록, 어제와 오늘이 만나는 곳, 민주화운동기념사업회 사료관이 만들어갑니다.
1. 오픈API URL
https://archives.kdemo.or.kr/search/SearchApi
key, query 파라메터는 필수로 입력되어야 한다.
2. 입력 파라메터 정의
- 파라메터
- 데이터 형태
- 입력값
- 설명
- query
- String(필수)
- 검색어
-
ASIS와 동일하게 UTF-8 인코딩 형태로 입력해야함.
(JAVA SCRIPT 상의 encodeURIComponent함수 사용한 형태)
- key
- String(필수)
- 오픈API 인증키 입력
- 인증키를 입력받는 파라메터.
컨트롤러에서 해당 키로 유효성 검증해서 유효한 경우에만 검색결과 출력
- sortType
- String(선택)
- 정렬형태 선택
-
정렬 선택
입력값 : WEIGHT - 정렬(정확도) (Default)
SORT_REGNO - 등록번호
SORT_TITLE - 제목
SORT_CREATOR - 생산자명
SORT_DONATOR - 기증자명
SORT_PRODUCT_START_DT - 생산일자
- sortValue
- String(선택)
- 사료 범위 선택
-
미구축사료. 구축사료 전체 등을 선택
입력값 – t : 사료전체 (Default)
0 : 미 구축사료
1 : 구축사료 전체
- page_no
- Integer(선택)
- 페이지 번호
-
검색결과 출력 페이지 번호.
정수만 입력해야함 (Default – 1)
- page_size
- Integer(선택)
- 페이지 사이즈
-
한 페이지 출력할 검색결과 개수 지정.
정수입력한 페이지 출력할 검색결과 개수 지정. 정수입력
1000개 까지만 지정가능함. (검색엔진 부하 문제)
Default - 100
- docCheck
- String(선택)
- “문서사료” 검색범위 선택 여부
-
검색대상에 “문서사료” 를 범위에 넣을 것인지 여부.
on 으로 입력하면 검색범위 포함.
on이외에 off등을 입력하면 검색범위 제외
Default – “on”
- imgCheck
- String(선택)
- “사진사료” 검색범위 선택 여부
-
검색대상에 “사진사료” 를 범위에 넣을 것인지 여부.
on 으로 입력하면 검색범위 포함.
on이외에 off등을 입력하면 검색범위 제외
Default – “on”
- filCheck
- String(선택)
- “영상사료” 검색범위 선택 여부
-
검색대상에 “영상사료” 를 범위에 넣을 것인지 여부.
on 으로 입력하면 검색범위 포함.
on이외에 off등을 입력하면 검색범위 제외
Default – “on”
- musCheck
- String(선택)
- “박물사료” 검색범위 선택 여부
-
검색대상에 “박물사료” 를 범위에 넣을 것인지 여부.
on 으로 입력하면 검색범위 포함.
on이외에 off등을 입력하면 검색범위 제외
Default – “on”
- start_time
- Integer(선택)
- 생산일자 시작기간 입력
-
생산일자를 원하는 범위로 입력하여 기간 필터링함.
입력시 start_time, end_time 두가지 모두 입력해아함.
입력형태 – yyyymm 형태의 6자리 정수
Ex) 201512
이외의 입력값이 들어오면 오류발생.
Default – “”
- end_time
- Integer(선택)
- 생산일자 종료기간 입력
- Default – “”
출력은 URL호출 시 XML 문서 형태로 출력된다.
샘플 페이지
[크롬] https://archives.kdemo.or.kr/search/SearchApi?key=test&query=민주화
[IE, 파이어폭스] https://archives.kdemo.or.kr/search/SearchApi?key=test&query=%EB%AF%BC%EC%A3%BC%ED%99%94
3. 출력형태 정의
- 속성명
- 데이터 형태
- 설명
- 비고
- TOTALCOUNT
- Integer
- 전체 검색결과 개수
- 전체 검색결과 개수 출력
- RESULT
- Integer
- 출력된 검색결과 개수
- 현재 출력된 검색결과 개수 출력
- PAGENO
- Integer
- 현재 페이지 번호
- 현재 출력된 검색결과의 페이지 번호 출력
- PAGESIZE
- Integer
- 한 페이지당 출력되는 결과 개수
-
한 페이지 당 출력할 검색결과 개수.
최대 1000개까지 출력함
- ITEM
- 각각 하나가 문서 사료 단위이다
- ITEM 태그 하나가 문서사료 문서 하나이다.
- CONTURL
- String
- 상세페이지 주소 URL
- TITLE
- String
- 제목
- STARTDT
- String
- 생산일자
- CLASS_FORM
- String
- 사료 유형
-
문서류
박물류
사진필름류
음성영상류
- IMG_PATH
- String
- 썸네일 이미지 URL
