API 상세 조회

운영자가 등록한 API명, 태그, 분류, API 신청 권한 등과 이용약관, 사용정책, 이용정책 등 API의 상세 정보를 볼 수 있습니다.

  1. 홈 화면 상단의 [API] 메뉴를 선택합니다.

    figure main api

  2. API 페이지가 열리면 특정 API를 클릭합니다.

  3. 선택한 API의 상세 정보 화면이 나타납니다.

    • ① 기본 정보 영역

      figure api details basic info

      항목 설명

      URL

      API의 호출 URL 정보입니다.

      제공기관

      해당 API를 제공한 기관명입니다.

      이용약관

      API 이용에 대한 약관입니다. [상세보기] 버튼을 클릭하여 전체 내용을 확인할 수 있습니다.

      사용정책

      API 이용에 대한 정책입니다. [상세보기] 버튼을 클릭하여 전체 내용을 확인할 수 있습니다.

      과금정책

      API 사용에 따른 과금 정책입니다. [상세보기] 버튼을 클릭하여 전체 내용을 확인할 수 있습니다.

      사용범위

      해당 API를 사용할 수 있는 사용자의 범위입니다.

      태그

      해당 API에 등록된 태그입니다.

    • ② 상세 정보 및 공지 영역

      figure api details tabs

      설명

      [상세설명]

      운영자가 등록한 상세 정보 배너가 제공됩니다. 운영자가 등록한 내용에 따라 해당 정보의 유형이 다르게 표시됩니다.

      [업데이트 공지]

      변경된 API의 상태(예: 수정, 삭제, 운영중지 등)의 업데이트 내역이 있는 경우, 'Update' 태그가 일주일간 노출되어 변경된 공지정보를 확인할 수 있습니다.

    • ③ 버튼 영역

      figure api details buttons

      버튼 설명

      [테스트 하기] 버튼

      해당 API를 테스트할 수 있는 API 테스트 신청 화면으로 이동합니다. 비로그인 사용자를 포함한 전체 회원 유형에게 제공되므로, 누구나 API 테스트를 이용할 수 있습니다.

      [이용신청] 버튼

      버튼을 클릭할 당시의 애플리케이션 등록 여부에 따라 각기 다른 화면으로 이동합니다.

      • 애플리케이션이 등록된 경우: 이용신청 화면으로 이동

      • 애플리케이션이 등록되지 않은 경우: 애플리케이션 정보 등록화면으로 이동

      이미 신청한 서비스의 경우 '신청완료'로, 이미 이용 중인 서비스의 경우에는 '이용중'으로 표시되며 신청 버튼이 비활성화됩니다.

      개인회원 또는 이용기관 사용자 및 관리자 회원에게만 제공되는 버튼입니다.

    • ④ 추천 서비스 리스트 영역

      figure api details recommendations

      같은 기관에서 등록한 서비스 리스트 또는 같은 분류의 서비스가 표시되며, 연관 서비스를 탐색할 수 있습니다. 클릭 시 해당 API 상세 정보 페이지로 이동합니다.

    • ⑤ 하단 정보 영역

      figure api details instruction button

      API 목록으로 되돌아가려면 [API 목록] 버튼을 클릭합니다.