본문 바로가기 대메뉴 바로가기
  • 데이터제공
  • 이용안내
  • 오픈API 사용방법

오픈API 사용방법

오픈 API 활용 신청 및 활용 목적

개발계정
  • Open API 활용신청 시 첫 번째 활용 단계입니다.
  • 제공기관에서 정의한 트래픽을 초과하여 활용할 수 없습니다.
운영계정
  • 개발계정 다음단계로 신청을 통해 진행 할 수있습니다.
  • 운영단계 신청 시 필요한 트래픽을 활용자가작성할 수 있습니다.
  • 운영신청 시 개발된 어플리케이션에 대해 내용을 활용사례로 등록해야 합니다

오픈 API활용 신청 후 승인 방식

자동승인
  • 활용신청에 대해 담당자의 별도 확인 없이 신청과 동시에 활용 할 수 있습니다.
운영계정
  • 활용신청에 대해 담당자가 확인 후 '승인' 이후 부터 사용 할 수 있습니다.
  • 신청 후 2~3일이 소요되고 결과는 회원가입 시 등록한 이메일로 발송합니다.

'서비스 키'의 발급

  • 서비스 키는 1인당 하나만 발급됩니다.
  • 서비스키는 활용자에게 발급되는 것으로 하나의 서비스키로 모든 OPEN API를 활용 할 수 있습니다.
  • 서비스키의 재발급
    • 서비스키를 재발급 받게 되면 이전 키는 자동으로 폐기되도록 처리되고 있습니다.
    • 기존 서비스키를새로운 서비스키로 교체하여야 활용되고 있는 서비스가 정상적으로 동작할 수 있습니다.

오픈 API 활용 신청 및 활용 목적

활용제한의 경우
  • 상업적이용이 불가능한 API에 대해 상업적 활용한 경우
  • 트래픽 초과로 인해 시스템에 부화가 발생할 경우
  • 기타 등의 이유로 제한될 수 있으며
  • API 활용현황 > API 활용내역에서각각의 상세한 제한사유를 확인 할 수 있습니다.
활용제한 종류
  • OPEN API 내 상세기능 단위로 활용하지 못하도록 제한합니다.
  • OPEN API 내 상세기능의 일일트래픽을 활용자가 신청한 트래픽 이하로 제한합니다.
Step1. 회원가입
  • 공유자원포탈의 회원으로 가입하셔야 OPEN API활용 신청을 하실 수 있습니다.
  • 일반회원 뿐만 아니라 기관회원도 활용신청이 가능합니다.
Step2. 개발계정 신청
  • OPEN API 상세화면 또는 목록화면의 [활용신청] 버튼을 클릭합니다.
  • 해당 OPEN API 서비스에 대해 최초 신청 시는 개발계정으로 신청됩니다.
  • 인증방법, 활용용도, 활용목적 및 기타 사항을 입력해야 합니다.
Step3. 개발계정 심의
  • 제공기관의 담당자가 신청내용 확인 후 승인합니다.
  • 신청내용이 미완성일 경우 반려 또는 보류 될 수 있습니다.
  • 2~3일 정도 소요되며, 이메일로 발송되고 API활용내역에서도 결과를 확인할 수 있습니다.
  • 개발계정의 심의구분이 자동승인 일 경우 신청 후 바로 사용할 수 있습니다.
Step4. 서비스키 발급
  • 개발계정신청에 대해 '승인'처리 된 경우 API활용내역내 상세화면에서 서비스키를 발급 받습니다.
  • 공유자원포탈에서 최초로 OPEN API활용신청을 했을 경우 신규로 발급됩니다.
  • 활용자당 1개의 서비스키만 유지됩니다.
Step5. 운영계정 신청
  • [API활용현황 > API활용내역]의 상세화면에서 신청 할 수 있습니다.
  • 운영계정 신청 시 원하는 트래픽을 신청 할 수 있습니다.
  • 또한, 개발된 어플리케이션에 대한 상세내용을 화면과 함께 등록해야 합니다.
Step6. 운영계정 심의
  • 제공기관의 담당자가 신청내용 확인 후 승인합니다.
  • 신청내용이 미완성일 경우 반려 또는 보류 될 수 있습니다.
  • 2~일 정도 소요되며, 이메일로 발송되고 API활용내역에서도 결과를 확인 할 수 있습니다.
  • 자동승인 일 경우 심의 없이 즉시 사용할 수 있습니다.

병무민원상담

  • 1588-9090
  • #1110-9090

현재 페이지의 정보에 만족하십니까?

  • 담당정보 : 데이터관리과
  • 담당자명 : 윤재기(042-481-2654)
  • 업데이트 : 2022-02-22