API 등록은 아래와 같은 절차로 진행됩니다. 각 단계를 클릭하여 상세 내용을 확인할 수 있습니다.
- 1. 제품 등록하기
이용을 원하는 API에 대해 테스트 신청을 진행해야 합니다.
- ① 동일한 제품명이어도 버전이 다른 경우, 다른 제품으로 취급됩니다.
- ② 제품의 카테고리, 제조일, 협업 희망분야 등을 입력합니다.
- ‘ * ‘로 표시된 항목은 필수 입력 사항으로 작성하지 않는 경우, 제품 등록이 불가합니다.
- ③ 제품 개요 및 특장점을 입력합니다.
- ④ 제품의 활용분야 입력 및 간단한 도식화 이미지를 첨부할 수 있습니다.
- 2. API 등록하기
제품 등록 후, API 등록을 진행합니다.
- ① API가 속한 제품을 선택합니다.
- ② API 검증/테스트 방법을 선택합니다.
온라인 및 오프라인으로 가능하며, 오프라인 중 테스트 베드에 제품을 제출할 경우 양식을 별도로 다운 받아야 합니다. - ③ API를 등록할 방법을 선택합니다.
- JSON 파일 등록 : JSON 파일을 첨부해야 합니다. 첨부 시, 파일을 바탕으로 내용은 자동 기입됩니다.
- 엑셀(xlsx) 파일 등록 : 엑셀 양식을 다운 받아 내용을 작성한 후, 첨부파일을 업로드합니다.
첨부 시, 파일을 바탕으로 내용은 자동 기입됩니다. - 직접 등록 : 별도 파일 첨부 없이, 각 항목을 직접 등록합니다.
- ④ API 정보를 등록할 수 있습니다.
- ⑤ Parameter, Response Body, 응답생태코드, 샘플코드 등을 입력할 수 있습니다.
[+], [-] 버튼을 통해 추가 및 삭제 가능합니다.
- ⑥ API 설명서 등 관련된 자료를 업로드 할 수 있습니다.
- ⑦ 내용 입력 후, 저장 버튼을 클릭하여야 저장됩니다.
- 3. API 연동검증
API 등록 후, 연동검증 절차를 진행합니다.
- ① 상세 보기를 통해 API 정보 및 검증 상태를
조회할 수 있습니다.
검증 방법이 여러 개인 경우, 각각의 검증 상태를 조회할 경우, 각각의 검증 상태를 조회할 수 있습니다. 그 중 하나라도 검증에 실패할 경우, 검증실패처리 됩니다. - ② API 검증 상태를 조회할 수 있습니다.
상세 보기를 하지 않고 검증 상태를 조회할 수 있습니다.
- ① 상세 보기를 통해 API 정보 및 검증 상태를
조회할 수 있습니다.
