Open API

Open API(Open Application Programming Interface)는 누구나 사용할 수 있도록 공개된 API로, K-BDS에서 제공하는 바이오 연구 데이터를 표준화된 형태로 외부 시스템에서도 활용할 수 있도록 지원하는 기능입니다. 외부 개발자 및 사용자는 웹 프로토콜을 통해 데이터를 호출하고 직접 활용할 수 있습니다.

Open API 신청 및 관리에 관련된 진행 사항은 Open API 관리 페이지 ([MYPAGE → My KBDS → Open API], Open API 관리 참고)에서 이루어집니다.

image.png

Open API 신청하기

image.png

**① [메뉴 → Services → OpenAPI → 사용신청]**을 클릭하여 페이지 이동 ② 개인정보 수집 및 이용 동의 내용을 확인하고 [☑️ 예, 동의합니다.] 선택 ③ 신청인 정보 작성 (K-BDS 계정 정보를 자동으로 가져옴) ④ 연구 설계 내용 작성

image.png

⑤ [Open API 검색] 시 Open API를 선택할 수 있는 팝업 창 생성 ⑥ [선택] 시 팝업 창이 닫히며, 선택된 Open API 정보가 자동으로 입력 ⑦ 선택한 Open API를 취소하고 싶은 경우, **[선택 해제]**를 클릭하면 선택된 API가 해제 됨

image.png

⑧ 활용 목적 및 내용 등 내용 작성 ⑨ 신청서를 전부 작성한 다음 [사용 신청] 선택 시 신청 됨 ⑩ “신청되었습니다.” 안내 창에서 [확인] 선택 ***시 Open API 관리 및 상세 페이지로 이동 * Open API 신청 결과는 **[MYPAGE → My KBDS → Open API]**에서 확인 가능

image.png

Open API 호출 예시

image.png

API URL K-BDS에서 제공하는 Open API URL 명
API 명 K-BDS의 Open API 서비스 내 고유 OpenAPI 명. 호출하고자 하는 API명 확인 필요
인증키 값 K-BDS에서 발급 받은 인증키
기본 인자 호출 문서(Type)의 기본 값은 XML
요청 인자 K-BDS의 각 서비스 별로 별도로 지정한 인자 값. 요청 인자가 제공하는 서비스만 가능하며, 자세한 정보는 해당 API의 명세서를 참조