설정 및 구성 항목

본 장에서는 관리자 계정의 API 포털 관리에 사용되는 설정 및 구성 항목 등에 대해 설명합니다.

서비스 상태 항목

서비스의 상태 값 항목에 대한 정의는 다음과 같습니다.

상태 설명

임시 등록

서비스 정보를 등록 후 신청자가 아직 "등록 요청 (승인 요청)"을 하지 않은 초기 상태입니다.

"임시 등록" 상태에서는 사용자 포털 화면에 노출되지 않으며 신청자는 자유롭게 API 서비스의 수정 또는 삭제가 가능합니다.

승인 대기

신청자가 등록 요청은 하였으나 아직 관리자의 결재 처리(승인 처리)가 시작되지 않은 상태입니다. "승인 대기" 상태에서 신청자는 신청 취소가 가능합니다.

"승인 대기" 상태에서 자신의 승인 처리 차례인 첫 번째 승인 담당자는 반려, 승인 취소, 승인 처리가 가능합니다.

결재중

결재 처리를 담당하는 관리자가 여러 명인 경우, 첫 번째 승인 담당자가 "승인" 처리를 한 이후부터 마지막 승인 담당자가 아직 승인 처리를 하지 않은 시점까지의 상태입니다. 만약 결재 처리를 담당하는 승인 담당자가 1명인 경우에는 "결재중" 상태값은 생략합니다. ("승인 대기" 상태에서 승인하면 바로 "승인 완료" 상태가 됩니다.) 신청자는 "결재중" 상태에서 신청 취소가 불가능합니다.

운영중 (승인 완료)

승인라인의 모든 승인 담당자가 "승인" 처리를 완료한 상태입니다. "승인 완료"가 되는 즉시 해당 서비스의 상태는 "운영중" 상태가 되어 사용자 포털 화면에 자동 노출됩니다. (단, 공개 여부가 "공개"인 경우에 한해)

반려

승인 신청 정보에 대해 보완이 필요한 경우 승인 담당자가 반려 처리를 한 상태입니다. "반려" 상태의 신청 데이터는 정보 수정 후 재신청이 가능합니다.

신청 취소

신청자가 "승인 대기" 상태인 경우에 한해 직접 취소한 상태입니다. "신청 취소"는 "반려"와는 다르게 신청 데이터가 종결 처리됩니다.

승인 취소

관리자가 자신의 승인 처리 차례에서 취소한 상태입니다. "신청 취소"와 마찬가지로 신청 데이터는 종결 처리됩니다.

API 상태 항목

API 상태 값 항목에 대한 정의는 다음과 같습니다.

상태 설명

임시 등록

API 정보를 등록 후 신청자가 아직 "등록 요청 (승인 요청)"을 하지 않은 초기 상태입니다. "임시 등록" 상태에서는 사용자 포털 화면에 노출되지 않으며 신청자는 자유롭게 API 정보의 수정 또는 삭제가 가능합니다.

승인 대기

신청자가 등록 요청은 하였으나 아직 관리자의 결재 처리(승인 처리)가 시작되지 않은 상태입니다. "승인 대기" 상태에서 신청자는 신청 취소가 가능합니다. "승인 대기" 상태에서 자신의 승인 처리 차례인 첫 번째 승인 담당자는 반려, 승인 취소, 승인 처리가 가능합니다.

결재중

결재 처리를 담당하는 관리자가 여러 명인 경우, 첫 번째 승인 담당자가 "승인" 처리를 한 이후부터 마지막 승인 담당자가 아직 승인 처리를 하지 않은 시점까지의 상태입니다. 만약 결재 처리를 담당하는 승인 담당자가 1명인 경우에는 "결재중" 상태값은 생략합니다. ("승인 대기" 상태에서 승인하면 바로 "승인 완료" 상태가 됩니다.) 신청자는 "결재중" 상태에서 신청 취소가 불가능합니다.

운영중 (승인 완료)

승인라인의 모든 승인 담당자가 "승인" 처리를 완료한 상태입니다. "승인 완료"가 되는 즉시 해당 API의 상태는 "운영중" 상태가 되어 사용자 포털 화면에 자동 노출됩니다. (단, 공개 여부가 "공개"인 경우에 한해)

반려

승인 신청 정보에 대해 보완이 필요한 경우 승인 담당자가 반려 처리를 한 상태입니다. "반려" 상태의 신청 데이터는 정보 수정 후 재신청이 가능합니다.

신청 취소

신청자가 "승인 대기" 상태인 경우에 한해 직접 취소한 상태입니다. "신청 취소"는 "반려"와는 다르게 신청 데이터가 종결 처리됩니다.

승인 취소

관리자가 자신의 승인 처리 차례에서 취소한 상태입니다. "신청 취소"와 마찬가지로 신청 데이터는 종결 처리됩니다.

운영 중지

"운영중" 상태에서 어떠한 사유로 인해 API 운영을 중지한 상태입니다. 해당 API를 이용 중인 사용자가 있더라도 "운영 중지" 상태가 되면 자동으로 이용 불가 상태가 됩니다. "운영 중지" 상태의 API는 다시 운영 개시 요청을 통해 "운영중" 상태로 변경 가능합니다. 단, 운영 중지 신청과 운영 개시 신청 모두 관리자의 승인 과정이 필요합니다.

API 상황별 서비스 구성 규칙

구분 데이터 예시 구성 규칙

API분류

금융, 라이프, 교통..

API분류가 다른 API들도 조합 가능. 구성 API 들의 API 분류는 무시하고 서비스를 등록할 때, 서비스 자체의 서비스 분류를 새롭게 설정

공개 여부

공개, 비공개

공개 API들로만 조합 가능. 비공개 API는 서비스 구성 불가

제공기관

동일한 "제공기관"의 API들로만 조합 가능

과금 정책

건별, 월별, 구간별

과금 정책이 다른 API들도 조합 가능. 각 API별로 적용된 과금정책 그대로 사용

사용 정책

할당량 설정, 시간제한 설정, 요일제한 설정

사용 정책이 다른 API들도 조합 가능. 각 API별로 적용된 사용정책 그대로 사용

신청 권한

개인회원, 이용기관 사용자, 이용기관 관리자

신청 권한이 다른 API들도 조합 가능. 구성 API들의 신청 권한은 무시하고 서비스를 등록할 때, 서비스 자체의 신청 권한을 새롭게 설정

신청가능 이용기관

전체 이용기관, 특정 이용기관

신청 가능 이용기관이 다른 API들도 조합 가능. 구성 API들의 신청 가능 이용기관은 무시하고 서비스를 등록할 때, 서비스 자체의 신청 가능 이용기관을 새롭게 설정

승인 권한&승인라인

Private(이용기관 포함), Private (이용기관 미포함), Public

승인 권한이 다른 API들도 조합 가능. 구성 API들의 승인 권한은 무시하고 서비스를 등록할 때, 서비스 자체의 승인 권한과 승인 라인을 새롭게 설정

승인 권한 항목

다음은 승인 권한의 각 설정값에 대한 설명입니다.

항목 설명

Private(이용기관 포함)

승인라인의 첫 번째 승인 담당자로 이용기관의 대표 승인자를 포함합니다.

  • 이용기관 사용자가 서비스 이용신청을 하는 경우: 첫 번째 승인 담당자로 해당 이용기관의 대표 승인자가 지정되어 첫 번째 승인 처리를 진행 → 해당 서비스에 지정된 승인라인대로 이후 승인을 진행합니다.

  • 개인회원, 이용기관 관리자가 서비스 이용신청을 하는 경우: 이용기관 관리자의 첫 번째 승인 과정은 생략하며 해당 서비스에 지정된 승인 라인대로 승인을 진행합니다.

Private(이용기관 미포함)

승인라인에 이용기관의 대표 승인자를 포함하지 않습니다.

  • 개인회원, 이용기관 사용자, 이용기관 관리자가 서비스 이용신청을 하는 경우 : 해당 서비스에 지정된 승인라인대로 승인을 진행합니다.

Public

승인 과정을 생략합니다. 사용자가 이용신청 즉시 서비스 이용이 가능합니다.

승인 상태 항목

승인 상태 설명

승인 대기

신청자가 승인 신청은 하였으나 아직 관리자의 결재 처리(승인 처리)가 시작되지 않은 초기 상태입니다. "승인 대기" 상태에서 신청자는 신청 취소가 가능합니다.

결재중

결재 처리를 담당하는 관리자가 여러 명인 경우, 첫 번째 승인 담당자가 "승인" 처리를 한 이후부터 마지막 승인 담당자가 승인 처리를 하기 전까지의 상태입니다. 만약 결재 처리를 담당하는 관리자가 1명인 경우에는 "결재중" 상태값은 생략합니다. "결재중" 상태에서 신청자는 신청 취소가 불가능합니다.

승인 완료

승인라인의 모든 승인 담당자가 "승인" 처리를 한 상태입니다.

반려

승인 신청 정보에 대해 보완이 필요한 경우 관리자가 반려 처리를 한 상태입니다. "반려" 상태의 신청 데이터는 정보 수정 후 재신청이 가능합니다.

신청 취소

신청자가 "승인 대기" 상태인 경우에 한해 직접 취소한 상태입니다. "신청 취소"는 "반려"와는 다르게 신청 데이터가 종결 처리됩니다.

승인 취소

관리자가 자신의 승인 처리 차례에서 취소한 상태입니다. "신청 취소"와 마찬가지로 신청 데이터는 종결 처리됩니다.

신청 유형 항목

다음은 관리자 계정의 [운영관리] > [신청 관리] 화면에서 설정할 수 있는 각 신청 유형에 대해 설명합니다.

신청 유형 설명 신청 주체 승인 주체

이용 신청

API, 서비스 정보를 이용하기 위해 요청하는 행위

개인회원 이용기관 사용자 이용기관 관리자

포털 관리자, 제공기관 관리자

등록 신청

API, 서비스 정보를 등록 후 포털에 노출시키기 위해 요청하는 행위

포털 관리자 제공기관 관리자

포털 관리자

수정 신청

API, 서비스를 수정할 때 예약 수정 항목의 경우에는 관리자의 승인 후 업데이트하기 위해 요청하는 행위

포털 관리자 제공기관 관리자

포털 관리자

삭제 신청

API, 서비스를 삭제할 때 관리자의 승인 후 삭제하기 위해 요청하는 행위

포털 관리자 제공기관 관리자

포털 관리자

운영중지 신청

현재 운영중인 API의 운영을 중지해야할 때, 관리자의 승인 후 운영 중지하기 위해 요청하는 행위

포털 관리자 제공기관 관리자

포털 관리자

운영개시 신청

현재 운영 중지된 API의 운영을 다시 시작해야할 때, 관리자의 승인 후 운영 개시하기 위해 요청하는 행위

포털 관리자 제공기관 관리자

포털 관리자

API 요금 구분 항목

다음은 포털 관리자, 제공기관 관리자가 등록 및 관리하는 API의 구분 항목에 대한 설명입니다.

요금 구분 설명 요금 계산 과금 집계 기준

건별

이용건당 과금

(이용건수 X 건별 요금) + 기본 요금

월 단위

월별

월 단위 정액 과금

월별 요금 + 기본 요금

월 단위

구간별

월 단위 이용구간에 대한 과금

  • 이용량이 지정한 구간 내에 있을 경우: 구간 요금 + 기본 요금

  • 이용량이 지정한 구간을 벗어난 경우: 구간 초과시 기본 요금 + 기본 요금

월 단위