Open API 인증키 신청방법
Open API 소개
대한불교조계종 Open API(Application Programming Interface)는 한국전통문화사진 디지털아카이브에서 제공하는 전통문화사진에 대한 검색 결과를 외부에 JSON 형태로 전달하는 방법입니다.
인증키 신청 방법
대한불교조계종 Open API를 이용하시려면 인증키가 필요합니다. 인증키는 API 이용 승인을 받은 기관 또는 이용자임을 식별할 수 있는 고유 값을 의미합니다. Open API 이용약관을 숙지하신 후 이용약관 하단의 ‘Open API 신청하기’ 버튼을 클릭하여 신청정보를 작성하시면 됩니다. 담당자의 승인이 완료되면, 신청하신 이메일로 인증키를 발급해드립니다. 발급받은 인증키를 이용하여 API 호출 결과를 확인하실 수 있습니다.
※ 담당자 문의 : 02-2011-1770, rosemay@buddhism.or.kr
Open API 사용 방법
요청 주소(request url)
1) 기본 입력 방법
http://ktda.buddhism.or.kr/syst/api/SystApiSearch.do?authAPIKey=API키
2) 검색 조건 입력 방법
http://ktda.buddhism.or.kr/syst/api/SystApiSearch.do?authAPIKey=API키&컬럼명=값
3) 다중 검색 조건 입력 방법
http://ktda.buddhism.or.kr/syst/api/SystApiSearch.do?authAPIKey=API키&컬럼명=값&컬럼명=값&컬럼명=값
※ 검색 값 입력 시 주의사항 : 검색 값에 한글을 입력해야 하는 경우 반드시 UTF-8 타입으로 인코딩해야 함
요청 변수(request parameter)
명칭 | 컬러명 | 타입 | 비고 |
---|---|---|---|
API KEY | authAPIKey | STRING | |
외부사진ID | op_id | NUMBER | |
사진관리번호 | p_mngno | STRING | |
제목 | p_title | STRING | |
사진유형 | p_typecd | CODE | 1 : 디지털파일, 2 : 스캔필름, 3 : 스캔인화사진, 4 : 동영상 |
작가명 | author | STRING | |
정렬 속성 | orderColumn | STRING | 정렬 속성 (OP_ID : 최신등록순, P_TITLE : 제목순, AUTHOR : 작가순)
※ 지정하지 않으면 최신등록순으로 결과 출력 |
정렬 순서 | orderType | STRING | 정렬 순서 (오름차순 : ASC, 내림차순 : DESC)
※ 지정하지 않으면 내림차순으로 결과 출력 |
건 개수 | pageUnit | NUMBER | 페이지당 출력 수 (기본 : 20, 최소 : 10)
※ 지정하지 않으면 기본 값으로 결과 출력 |
페이지번호 | pageIndex | NUMBER | 시작 페이지 (기본 : 1)
※ 지정하지 않으면 기본 값으로 결과 출력 |
출력 결과 필드(response field)
명칭 | 컬러명 | 타입 |
---|---|---|
외부사진ID | op_id | NUMBER |
사진관리번호 | p_mngno | STRING |
제목 | p_title | STRING |
촬영시기 | p_dt | STRING |
촬영지역 | p_place | STRING |
촬영지역 상세주소 | p_placedetl | STRING |
사진유형 | p_typecd_nm | STRING |
상세설명 | contents | STRING |
작가명 | author | STRING |
저작권자명 | copyright_holder | STRING |
초상권 | portrait_rights_nm | STRING |
라이선스타입 | licence_type_nm | STRING |
CCL | ccl_nm | STRING |
썸네일사진 URL | thum_file_path | STRING |
에러 코드(error code)
에러 코드 | 에러 내용 |
---|---|
1001 | 잘못된 인증키 또는 사용이 중지된 인증키입니다. |
2001 | 시스템 에러가 발생했습니다. |