OpenAPI소개

OPEN API 활용에는 2가지 단계가 있습니다.

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

OPEN API 활용신청에 대한 2가지 승인처리가 있습니다.

01. 자동승인
활용신청에 대해 제공기관 담당자의 별도 확인 없이 신청과 동시에 활용할 수 있습니다.
02. 승인심의
활용신청에 대해 제공기관 담당자가 확인 후 '승인' 이후 부터 사용할 수 있습니다.
신청 후 2~3일이 소요되고 결과는 회원가입 시 등록한 e-mail로 발송합니다.
  • 개발계정과 운영계정의 승인유형이 일치하지 않는 경우 달리 운영될 수 있습니다.
  • 예) 개발계정 : '자동승인' - 운영계정 : '승인심의'인 경우 개발계정 신청은 자동승인으로 신청과 함께 바로 가능하나, 운영계정 신청은 승인심의로 제공기관 담당자의 확인 후 활용 가능합니다.

OPEN API 활용에 반드시 '서비스키'를 발급받으셔야 합니다.

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

제공기관에서 OPEN API 활용을 제한할 수 있습니다.

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