API 관리

포털 관리자, 제공기관 관리자 소속기관의 API 정보를 관리합니다.

포털 관리자는 자신의 소속기관뿐만 아니라 모든 기관의 API 데이터를 조회, 등록, 수정, 삭제가 가능합니다.
제공기관 관리자는 자신의 소속기관의 API 데이터만 조회, 등록, 수정, 삭제가 가능합니다.

API 조회

API 포털에 관리자 계정으로 로그인 후 [운영 관리] > [API 관리] 메뉴를 클릭합니다.

API 관리 페이지가 열립니다.

figure api management main

① 조건 설정 영역

항목	설명
조회 조건	드롭다운 메뉴에서 API명, 제공기관명, 등록자 중 조회할 조건을 선택합니다. API명: API 이름을 검색합니다. 제공기관명: API의 운영 주체인 제공기관명을 검색합니다. 등록자: API 정보를 등록한 관리자의 이름을 검색합니다. [텍스트 필드 입력 조건] 최대 50자까지 입력(공백 포함) 영문/한글/숫자만 입력 가능
API 분류	금융, 공공, 생활편의 등 API 분류 옵션을 선택합니다. API 분류는 기초정보 관리 > 공통코드 관리 메뉴에서 'API 분류' 상세코드로 관리합니다.
상태	드롭다운 목록에서 분류하고자 하는 상태값을 선택합니다. 목록에서 제공하는 상태 옵션은 전체, 임시 등록, 승인 대기, 결재중, 운영중, 반려, 신청 취소, 승인 취소, 운영 중지이며, 각 상태값에 대한 정의는 API 상태 항목를 참고 합니다.
공개 여부	전체, 공개, 비공개 중 조회하려는 옵션을 선택합니다.
[초기화] 버튼	검색 결과를 초기화하여 기본 검색 조건 상태로 변경합니다.
[검색] 버튼	입력 또는 선택한 검색 조건의 결과값을 출력합니다. 검색 결과가 없을 경우, 하단 리스트 영역에 '조회된 데이터가 없습니다.' 텍스트가 표시 됩니다.

항목

설명

조회 조건

드롭다운 메뉴에서 API명, 제공기관명, 등록자 중 조회할 조건을 선택합니다.

API명: API 이름을 검색합니다.
제공기관명: API의 운영 주체인 제공기관명을 검색합니다.
등록자: API 정보를 등록한 관리자의 이름을 검색합니다.

[텍스트 필드 입력 조건]

최대 50자까지 입력(공백 포함)
영문/한글/숫자만 입력 가능

API 분류

금융, 공공, 생활편의 등 API 분류 옵션을 선택합니다. API 분류는 기초정보 관리 > 공통코드 관리 메뉴에서 'API 분류' 상세코드로 관리합니다.

상태

드롭다운 목록에서 분류하고자 하는 상태값을 선택합니다. 목록에서 제공하는 상태 옵션은 전체, 임시 등록, 승인 대기, 결재중, 운영중, 반려, 신청 취소, 승인 취소, 운영 중지이며, 각 상태값에 대한 정의는 API 상태 항목를 참고 합니다.

공개 여부

전체, 공개, 비공개 중 조회하려는 옵션을 선택합니다.

[초기화] 버튼

검색 결과를 초기화하여 기본 검색 조건 상태로 변경합니다.

[검색] 버튼

입력 또는 선택한 검색 조건의 결과값을 출력합니다. 검색 결과가 없을 경우, 하단 리스트 영역에 '조회된 데이터가 없습니다.' 텍스트가 표시 됩니다.

Like 검색 방식이 사용되며, 2개 이상의 검색 조건을 설정 후 검색할 경우 AND 검색 방식이 적용됩니다.

② 검색 결과 영역

상단의 검색 조건 입력 후 [검색] 버튼을 클릭하면 조건에 해당하는 데이터가 목록으로 표시됩니다. 목록의 각 항목을 클릭 시 해당 데이터의 상세 화면이 실행됩니다.

항목	설명
API명	API의 이름입니다.
API 분류	금융, 공공, 생활편의 등 API 분류 옵션입니다.
제공기관명	API를 제공하는 기관입니다.
승인 권한	승인(결재) 관련 설정값입니다. Public Private (이용기관 포함) Private (이용기관 미포함)
공개 여부	해당 API의 공개 여부를 표시합니다.
PICK	토글 버튼을 이용하여 'ON(사용함)' 혹은 'OFF(사용 안함)'을 설정하여 사용자 포털 화면의 API 목록에서 해당 API 카드 이미지에 아이콘을 표시하거나 해제합니다. 포털 관리자 전용 기능으로 제공기관 관리자는 토글 버튼을 ON/OFF 할 수 없습니다. 지정 개수에 제한은 없으며, 여러 개를 지정한 경우 API 목록의 현재 정렬 기준에 따라 노출 우선 순위가 결정됩니다. 지정된 API는 사용자 포털 화면의 API 목록 최상단에 고정 노출됩니다. 고정 노출의 기간 제한은 없습니다.
상태	해당 API의 상태를 표시합니다.
등록자	API를 등록한 사람의 이름입니다.
등록일시	API가 등록된 날짜와 시간입니다.
[등록요청] 버튼	API 정보를 등록 후, 사용자 포털 화면에 노출시키기 위해 포털 관리자에게 승인을 요청할 수 있습니다. 아래의 2가지 조건을 모두 충족할 경우에만 [등록 요청] 버튼이 노출됩니다. 자신의 기관에서 등록한 API 데이터인 경우 API 상태가 "임시 등록" 또는 "반려"인 경우 등록 요청을 완료하면 해당 API의 상태가 '승인 대기'로 변경됩니다. 이후 신청 진행 과정의 모니터링 및 관리는 운영 관리 > 신청 관리 메뉴에서 가능합니다.

항목

설명

API명

API의 이름입니다.

API 분류

금융, 공공, 생활편의 등 API 분류 옵션입니다.

제공기관명

API를 제공하는 기관입니다.

승인 권한

승인(결재) 관련 설정값입니다.

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

공개 여부

해당 API의 공개 여부를 표시합니다.

PICK

토글 버튼을 이용하여 'ON(사용함)' 혹은 'OFF(사용 안함)'을 설정하여 사용자 포털 화면의 API 목록에서 해당 API 카드 이미지에 figure pick icon 아이콘을 표시하거나 해제합니다.

포털 관리자 전용 기능으로 제공기관 관리자는 토글 버튼을 ON/OFF 할 수 없습니다.
지정 개수에 제한은 없으며, 여러 개를 지정한 경우 API 목록의 현재 정렬 기준에 따라 노출 우선 순위가 결정됩니다.
지정된 API는 사용자 포털 화면의 API 목록 최상단에 고정 노출됩니다. 고정 노출의 기간 제한은 없습니다.

상태

해당 API의 상태를 표시합니다.

등록자

API를 등록한 사람의 이름입니다.

등록일시

API가 등록된 날짜와 시간입니다.

[등록요청] 버튼

API 정보를 등록 후, 사용자 포털 화면에 노출시키기 위해 포털 관리자에게 승인을 요청할 수 있습니다.

아래의 2가지 조건을 모두 충족할 경우에만 [등록 요청] 버튼이 노출됩니다.

자신의 기관에서 등록한 API 데이터인 경우
API 상태가 "임시 등록" 또는 "반려"인 경우

등록 요청을 완료하면 해당 API의 상태가 '승인 대기'로 변경됩니다. 이후 신청 진행 과정의 모니터링 및 관리는 운영 관리 > 신청 관리 메뉴에서 가능합니다.

③ [등록] 버튼

신규 API를 등록할 수 있습니다. 클릭 시 API 등록 화면으로 이동합니다.

API 등록

[운영 관리] > [API 관리] 메뉴를 클릭합니다.

API 관리 페이지의 오른쪽 상단에서 [등록] 버튼을 클릭하면 API 등록 화면이 열립니다.

figure api register main

① 기본정보

다음은 등록할 API의 기본 정보 입력 항목입니다. (*: 필수 입력 항목)

항목	설명
API명 *	API 이름을 입력합니다. 최대 20자까지 입력 가능합니다.
API 분류 *	API 분류를 선택합니다. API 분류는 기초정보 관리 > 공통코드 관리 메뉴에서 'API 분류' 상세코드를 불러오기합니다.
제공기관명 *	해당 API를 제공하는 기관을 의미합니다. 포털 관리자가 API를 등록하는 경우에는 자신의 소속기관명이 기본값으로 표시되며, 드롭다운으로 다른 제공기관을 선택할 수 있습니다. 기초정보 관리 > 제공기관 관리에 등록한 제공기관 이름이 표시됩니다. 단, 제공기관 관리자가 API를 등록할 경우에는 제공기관 필드에 자신의 소속기관명이 고정으로 표시됩니다.
공개 여부 *	공개, 비공개 여부를 선택합니다. '운영중' 상태이며 '공개'로 설정한 API의 경우에만 사용자 포털 화면에 노출됩니다. API의 등록 승인 요청이 완료되었더라도 '비공개' 상태인 API는 사용자 포털 화면에 노출되지 않습니다.
호출 URL *	Method 선택 및 호출 URL(최대 100자 입력 가능)을 입력합니다.
API 라우팅 URL *	Method 선택 및 API 라우팅 URL(최대 100자 입력 가능)을 입력합니다.
소개 문구 *	사용자 포털 화면의 API 목록 화면 및 상세 화면에 노출되는 간략 소개 문구를 입력합니다. 최대 100자까지 입력 가능합니다.
이용약관 *	해당 API의 이용약관입니다. 운영관리 > API 이용약관 관리 메뉴에서 등록한 이용약관을 불러옵니다. '없음'을 선택할 경우 이용약관은 적용되지 않습니다. 제공기관 필드에서 제공기관이 선택되지 않은 상태에서는 이용약관을 선택할 수 없습니다.
사용정책 *	해당 API의 사용 관련 정책을 설정합니다. 운영관리 > API 사용정책 관리 메뉴에서 등록한 사용정책을 불러옵니다. '없음'을 선택할 경우 사용정책은 적용되지 않습니다. 제공기관 필드에서 제공기관이 선택되지 않은 상태에서는 사용정책을 선택할 수 없습니다.
과금정책 *	해당 API의 과금 정책을 설정합니다. 사용: 과금정책 상세 드롭다운이 활성화되며 필수 선택값이 됩니다. 무과금: 과금정책 상세 드롭다운이 비활성화되며, 사용자 포털 화면의 API 상세 정보 화면에서도 [과금 정책] 버튼이 비활성화됩니다. API를 무료로 이용 가능하여 과금이 발생하지 않습니다.
과금정책 상세 *	해당 API의 과금 관련 정책을 설정합니다. 운영관리 > API 과금정책 관리 메뉴에서 등록한 과금정책을 불러옵니다. 제공기관 필드에서 제공기관이 선택되지 않은 상태에서는 과금정책을 선택할 수 없습니다.
태그	검색용 키워드입니다. 최대 5개까지 추가 가능하며, 태그당 최대 10자까지 입력 가능합니다.
아이콘 *	선택한 아이콘이 사용자 포털 화면의 API 목록 및 상세정보 화면에 표시됩니다. 단, '사용안함'을 선택할 경우에는 아이콘이 노출되지 않습니다.

항목

설명

API명 *

API 이름을 입력합니다. 최대 20자까지 입력 가능합니다.

API 분류 *

API 분류를 선택합니다. API 분류는 기초정보 관리 > 공통코드 관리 메뉴에서 'API 분류' 상세코드를 불러오기합니다.

제공기관명 *

해당 API를 제공하는 기관을 의미합니다. 포털 관리자가 API를 등록하는 경우에는 자신의 소속기관명이 기본값으로 표시되며, 드롭다운으로 다른 제공기관을 선택할 수 있습니다. 기초정보 관리 > 제공기관 관리에 등록한 제공기관 이름이 표시됩니다.

단, 제공기관 관리자가 API를 등록할 경우에는 제공기관 필드에 자신의 소속기관명이 고정으로 표시됩니다.

공개 여부 *

공개, 비공개 여부를 선택합니다.

'운영중' 상태이며 '공개'로 설정한 API의 경우에만 사용자 포털 화면에 노출됩니다.
API의 등록 승인 요청이 완료되었더라도 '비공개' 상태인 API는 사용자 포털 화면에 노출되지 않습니다.

호출 URL *

Method 선택 및 호출 URL(최대 100자 입력 가능)을 입력합니다.

API 라우팅 URL *

Method 선택 및 API 라우팅 URL(최대 100자 입력 가능)을 입력합니다.

소개 문구 *

사용자 포털 화면의 API 목록 화면 및 상세 화면에 노출되는 간략 소개 문구를 입력합니다. 최대 100자까지 입력 가능합니다.

이용약관 *

해당 API의 이용약관입니다. 운영관리 > API 이용약관 관리 메뉴에서 등록한 이용약관을 불러옵니다.

'없음'을 선택할 경우 이용약관은 적용되지 않습니다.
제공기관 필드에서 제공기관이 선택되지 않은 상태에서는 이용약관을 선택할 수 없습니다.

사용정책 *

해당 API의 사용 관련 정책을 설정합니다. 운영관리 > API 사용정책 관리 메뉴에서 등록한 사용정책을 불러옵니다.

'없음'을 선택할 경우 사용정책은 적용되지 않습니다.
제공기관 필드에서 제공기관이 선택되지 않은 상태에서는 사용정책을 선택할 수 없습니다.

과금정책 *

해당 API의 과금 정책을 설정합니다.

사용: 과금정책 상세 드롭다운이 활성화되며 필수 선택값이 됩니다.
무과금: 과금정책 상세 드롭다운이 비활성화되며, 사용자 포털 화면의 API 상세 정보 화면에서도 [과금 정책] 버튼이 비활성화됩니다. API를 무료로 이용 가능하여 과금이 발생하지 않습니다.

과금정책 상세 *

해당 API의 과금 관련 정책을 설정합니다.

운영관리 > API 과금정책 관리 메뉴에서 등록한 과금정책을 불러옵니다.
제공기관 필드에서 제공기관이 선택되지 않은 상태에서는 과금정책을 선택할 수 없습니다.

태그

검색용 키워드입니다. 최대 5개까지 추가 가능하며, 태그당 최대 10자까지 입력 가능합니다.

아이콘 *

선택한 아이콘이 사용자 포털 화면의 API 목록 및 상세정보 화면에 표시됩니다. 단, '사용안함'을 선택할 경우에는 아이콘이 노출되지 않습니다.

② [상세 설명] 탭

사용자 포털 화면의 API 상세정보 페이지에 노출되는 상세 설명을 입력합니다. 최대 글자수는 제한이 없으며 이미지 삽입도 가능합니다.

③ [권한 설정] 탭

API 이용 신청을 할 수 있는 권한을 설정합니다.

figure service register permission setting

예시 이미지의 표시된 항목은 설정값에 따라 노출 여부가 달라집니다. 자세한 사항은 아래 각 항목 설명을 참고합니다.

다음은 권한 설정 탭의 각 항목을 설명합니다. (*: 필수 설정 항목)

구분	항목	설명
신청 권한 정보	신청 권한 *	신청 권한을 부여할 사용자를 선택합니다. 신청 권한으로 설정된 사용자들에게만 사용자 포털 화면의 해당 API 상세정보 페이지에서 [이용 신청] 버튼이 표시됩니다. '개인회원'만 선택한 경우, 신청 가능 이용기관 필드가 노출되지 않습니다. '이용기관 사용자', '이용기관 관리자' 중에 하나라도 선택한 경우, 신청 가능 이용기관 필드가 노출됩니다. 신청 권한은 최소 1개 이상 선택 필수입니다.
신청 가능 이용기관 *	신청할 수 있는 이용기관을 설정합니다. '전체 이용기관' 선택 시: 이용기관 필드가 노출되지 않습니다. '특정 이용기관' 선택 시: 이용기관 필드가 화면에 노출됩니다.
이용기관 *	원하는 이용기관을 선택합니다. 신청 가능 이용기관 필드에서 특정 이용기관을 선택했을 때 노출되는 항목입니다. 드롭다운 메뉴를 클릭하면 기초정보 관리 > 이용기관 관리에 등록된 이용기관이 표시됩니다. 2개 이상의 이용기관을 지정한 경우 버튼이 활성화되어 삭제도 가능합니다. 해당 필드에서 선택된 이용기관의 사용자, 관리자들에게만 사용자 포털 화면의 해당 API 상세정보 페이지에서 [이용 신청] 버튼이 표시됩니다.
이용기관 추가	[추가] 버튼을 클릭하여 이용기관을 추가할 수 있습니다.
승인 권한 정보	승인 권한 *	승인 권한을 설정합니다. Private(이용기관 포함) 또는 Private(이용기관 미포함) 선택 시: 승인라인 불러오기 화면이 노출됩니다. Public 선택 시: 승인라인 불러오기 화면이 노출되지 않습니다. 각 승인 권한에 대한 정의는 승인 권한 항목를 참고합니다.
승인라인 불러오기	운영관리 > 승인라인 관리 메뉴에서 등록한 승인라인 데이터를 불러옵니다. 기본값으로 '대표 승인라인’으로 지정된 승인라인이 자동 선택되어 승인 담당자 영역에 대표 승인라인의 인원들이 자동 표시됩니다. 단, 대표 승인라인이 없는 경우에는 기본값으로 대표 승인라인이 선택되지 않습니다. 승인라인 선택값 변경 시, 승인 담당자 영역의 인원도 선택 승인라인에 맞춰 자동 변경됩니다. 상단의 승인 권한 필드에서 'Public' 선택 시 해당 필드는 노출되지 않습니다.
승인 담당자 *	승인라인에 포함되는 인원 및 승인 순서 등을 지정합니다. 드롭다운 메뉴에서 승인 담당자를 선택합니다. 2명 이상일 경우 버튼이 활성화되어 담당자를 삭제할 수도 있습니다. 하나의 승인 라인에 동일 인물이 두 번 이상 포함될 수 없습니다. 승인 담당자는 최소 1명 이상 지정되어야 하며, 최대 인원수 제한은 없습니다.
승인 담당자 추가	[추가] 버튼을 클릭하여 담당자를 추가할 수 있습니다.

구분

항목

설명

신청 권한 정보

신청 권한 *

신청 권한을 부여할 사용자를 선택합니다. 신청 권한으로 설정된 사용자들에게만 사용자 포털 화면의 해당 API 상세정보 페이지에서 [이용 신청] 버튼이 표시됩니다.

'개인회원'만 선택한 경우, 신청 가능 이용기관 필드가 노출되지 않습니다.
'이용기관 사용자', '이용기관 관리자' 중에 하나라도 선택한 경우, 신청 가능 이용기관 필드가 노출됩니다.
신청 권한은 최소 1개 이상 선택 필수입니다.

신청 가능 이용기관 *

신청할 수 있는 이용기관을 설정합니다.

'전체 이용기관' 선택 시: 이용기관 필드가 노출되지 않습니다.
'특정 이용기관' 선택 시: 이용기관 필드가 화면에 노출됩니다.

이용기관 *

원하는 이용기관을 선택합니다.

신청 가능 이용기관 필드에서 특정 이용기관을 선택했을 때 노출되는 항목입니다.
드롭다운 메뉴를 클릭하면 기초정보 관리 > 이용기관 관리에 등록된 이용기관이 표시됩니다.
2개 이상의 이용기관을 지정한 경우 버튼이 활성화되어 삭제도 가능합니다.
해당 필드에서 선택된 이용기관의 사용자, 관리자들에게만 사용자 포털 화면의 해당 API 상세정보 페이지에서 [이용 신청] 버튼이 표시됩니다.

이용기관 추가

[추가] 버튼을 클릭하여 이용기관을 추가할 수 있습니다.

승인 권한 정보

승인 권한 *

승인 권한을 설정합니다.

Private(이용기관 포함) 또는 Private(이용기관 미포함) 선택 시: 승인라인 불러오기 화면이 노출됩니다.
Public 선택 시: 승인라인 불러오기 화면이 노출되지 않습니다.

각 승인 권한에 대한 정의는 승인 권한 항목를 참고합니다.

승인라인 불러오기

운영관리 > 승인라인 관리 메뉴에서 등록한 승인라인 데이터를 불러옵니다.

기본값으로 '대표 승인라인’으로 지정된 승인라인이 자동 선택되어 승인 담당자 영역에 대표 승인라인의 인원들이 자동 표시됩니다. 단, 대표 승인라인이 없는 경우에는 기본값으로 대표 승인라인이 선택되지 않습니다.
승인라인 선택값 변경 시, 승인 담당자 영역의 인원도 선택 승인라인에 맞춰 자동 변경됩니다.
상단의 승인 권한 필드에서 'Public' 선택 시 해당 필드는 노출되지 않습니다.

승인 담당자 *

승인라인에 포함되는 인원 및 승인 순서 등을 지정합니다. 드롭다운 메뉴에서 승인 담당자를 선택합니다. 2명 이상일 경우 figure cancel adding ip icon 버튼이 활성화되어 담당자를 삭제할 수도 있습니다.

하나의 승인 라인에 동일 인물이 두 번 이상 포함될 수 없습니다.
승인 담당자는 최소 1명 이상 지정되어야 하며, 최대 인원수 제한은 없습니다.

승인 담당자 추가

[추가] 버튼을 클릭하여 담당자를 추가할 수 있습니다.

④ [Document] 탭

figure api register document tab

Headers, Query String, Body, Spec 항목을 제공하며 각 텍스트를 클릭하면 설정할 수 있는 창이 펼쳐집니다. (*: 필수 설정 항목)

구분	항목	설명
Headers	Key *	키를 입력합니다. (최대 20자까지 입력 가능)
설명	해당 키의 설명을 입력합니다. (최대 20자까지 입력 가능)
Type *	해당 키의 타입을 선택합니다. Type 선택 값: String, Object, Long, Double, Integer, Boolean
Array 여부	Array 여부를 선택합니다. 기본값은 미선택 상태입니다.
Default Value	해당 키의 기본값을 입력합니다. 최대 20자까지 입력 가능합니다. 입력 정보는 사용자 포털 화면의 API 테스트 화면에서 기본값으로 표시되며 사용자가 수정할 수도 있습니다.
필수 여부 *	토글 버튼(True/False)으로 해당 키의 필수 입력 여부를 설정합니다.
Query String	각 항목의 속성 및 기능은 'Headers' 영역의 항목과 동일합니다.
Body	JSON 에디터를 활용하여 해당 API의 body 정보를 입력합니다. Media Type: application/json, application/xml 중에서 선택 가능합니다.
Spec	각 항목의 속성 및 기능은 'Headers' 영역의 항목과 동일합니다.
[추가] 버튼	목록에 행을 추가합니다. 행 추가 개수의 제한은 없습니다.
[삭제] 버튼	해당 행을 목록에서 삭제합니다.
[위로]/[아래로] 버튼	행 선택 후 [위로] 혹은 [아래로] 버튼을 이용하여 위치를 이동합니다.

구분

항목

설명

Headers

Key *

키를 입력합니다. (최대 20자까지 입력 가능)

설명

해당 키의 설명을 입력합니다. (최대 20자까지 입력 가능)

Type *

해당 키의 타입을 선택합니다.

Type 선택 값: String, Object, Long, Double, Integer, Boolean

Array 여부

Array 여부를 선택합니다. 기본값은 미선택 상태입니다.

Default Value

해당 키의 기본값을 입력합니다. 최대 20자까지 입력 가능합니다.

입력 정보는 사용자 포털 화면의 API 테스트 화면에서 기본값으로 표시되며 사용자가 수정할 수도 있습니다.

필수 여부 *

토글 버튼(True/False)으로 해당 키의 필수 입력 여부를 설정합니다.

Query String

각 항목의 속성 및 기능은 'Headers' 영역의 항목과 동일합니다.

Body

JSON 에디터를 활용하여 해당 API의 body 정보를 입력합니다.

Media Type: application/json, application/xml 중에서 선택 가능합니다.

Spec

각 항목의 속성 및 기능은 'Headers' 영역의 항목과 동일합니다.

[추가] 버튼

목록에 행을 추가합니다. 행 추가 개수의 제한은 없습니다.

[삭제] 버튼

해당 행을 목록에서 삭제합니다.

[위로]/[아래로] 버튼

행 선택 후 [위로] 혹은 [아래로] 버튼을 이용하여 위치를 이동합니다.

⑤ 버튼

버튼	설명
[등록] 버튼	모든 필수입력값을 입력한 상태에서만 버튼이 활성화됩니다. 필수입력값을 모두 입력 후, [등록] 버튼을 클릭하면 입력 정보를 저장할 수 있습니다.
[취소] 버튼	클릭 시 등록 취소 팝업이 실행됩니다. 등록 취소를 완료하면 입력했던 정보는 저장되지 않은 채 목록 화면으로 이동합니다.

버튼

설명

[등록] 버튼

모든 필수입력값을 입력한 상태에서만 버튼이 활성화됩니다. 필수입력값을 모두 입력 후, [등록] 버튼을 클릭하면 입력 정보를 저장할 수 있습니다.

[취소] 버튼

클릭 시 등록 취소 팝업이 실행됩니다. 등록 취소를 완료하면 입력했던 정보는 저장되지 않은 채 목록 화면으로 이동합니다.

API 상세 조회

API 정보를 상세하게 조회할 수 있습니다.

[운영 관리] > [API 관리] 메뉴를 클릭합니다.

API 관리 화면의 목록에서 특정 행을 클릭하면 해당 API에 대한 API 상세 화면이 열립니다.

항목	설명
기본정보	해당 API의 기본 정보를 표시합니다. 수정이 가능한 필드를 클릭할 경우, 편집 모드로 전환됩니다.
최종 수정 정보	해당 정보를 최초 등록한 관리자 이름 및 등록일시, 가장 최근에 수정한 관리자 이름 및 수정일시가 표시됩니다.
연동 APP 정보	해당 API의 이용신청을 한 사용자 APP 목록이 표시됩니다.
탭 정보	상세 설명, 권한 설정, 구성 API 탭을 조회하고 수정할 수 있습니다.
[운영 중지] 버튼	해당 API를 운영 중지합니다.
[삭제] 버튼	해당 API를 삭제합니다.

항목

설명

기본정보

해당 API의 기본 정보를 표시합니다. 수정이 가능한 필드를 클릭할 경우, 편집 모드로 전환됩니다.

최종 수정 정보

해당 정보를 최초 등록한 관리자 이름 및 등록일시, 가장 최근에 수정한 관리자 이름 및 수정일시가 표시됩니다.

연동 APP 정보

해당 API의 이용신청을 한 사용자 APP 목록이 표시됩니다.

탭 정보

상세 설명, 권한 설정, 구성 API 탭을 조회하고 수정할 수 있습니다.

[운영 중지] 버튼

해당 API를 운영 중지합니다.

[삭제] 버튼

해당 API를 삭제합니다.

API 수정

API 정보 및 설정을 수정합니다.

[운영 관리] > [API 관리] 메뉴를 클릭합니다.
목록에서 수정을 원하는 API 항목을 클릭하면 해당 API 상세 화면이 열립니다.

API 상세 화면에서 수정 가능한 필드를 클릭하면 수정 가능한 상태로 전환됩니다.

figure api edit

다음은 수정 페이지의 각 버튼에 대한 설명입니다.

수정 항목에 대한 자세한 설명은 API 등록을 참고합니다.

항목	설명
[저장]	모든 필수입력값을 입력한 상태에서만 활성화됩니다. 필수입력값을 모두 입력 후 버튼을 클릭하면 아래 2가지 케이스에 따라 다른 상황이 발생합니다. 즉시 수정 가능한 정보만 수정한 경우: 수정 확인 팝업이 실행되어 즉시 수정이 가능합니다. 예약 수정 가능 정보를 수정하는 경우(즉시 수정 가능한 정보와 예약 수정 가능 정보를 동시에 수정한 경우도 포함): 알림 메시지 화면이 나타나며 수정 예약 프로세스를 진행합니다.
[취소]	클릭 시 수정 취소 팝업이 실행됩니다. 수정 취소를 완료하면 입력했던 정보는 저장되지 않은 채 상세 화면으로 이동합니다.

항목

설명

[저장]

모든 필수입력값을 입력한 상태에서만 활성화됩니다. 필수입력값을 모두 입력 후 버튼을 클릭하면 아래 2가지 케이스에 따라 다른 상황이 발생합니다.

즉시 수정 가능한 정보만 수정한 경우: 수정 확인 팝업이 실행되어 즉시 수정이 가능합니다.
예약 수정 가능 정보를 수정하는 경우(즉시 수정 가능한 정보와 예약 수정 가능 정보를 동시에 수정한 경우도 포함): 알림 메시지 화면이 나타나며 수정 예약 프로세스를 진행합니다.

[취소]

클릭 시 수정 취소 팝업이 실행됩니다. 수정 취소를 완료하면 입력했던 정보는 저장되지 않은 채 상세 화면으로 이동합니다.

즉시 수정 가능 항목: API명, API 분류, 공개 여부, 소개 문구, 이용약관, 태그, 아이콘, 상세 설명, 권한 설정(신청 권한, 신청 가능 이용기관, 이용기관, 승인 권한, 승인라인 불러오기, 승인 담당자)
예약 수정 항목: 호출 URL, API 라우팅 URL, 사용정책, 과금정책, 과금정책 상세, Document 영역 전체

API 수정 화면에서 예약 수정 항목을 변경 후 [저장] 버튼을 클릭합니다.

알림 메시지 화면이 나타나면 유예기간 및 알림 메시지를 설정합니다. (*: 필수 입력 항목)

figure notification setting dialog

항목	설명
유예기간 *	유예기간을 선택합니다. 즉시반영: 유예기간 없이 즉시 설정을 반영합니다. 해당 옵션 선택 시 예약 반영 필드는 비활성화됩니다. 예약반영: 특정 기간 경과 후 실행되도록 합니다. 해당 옵션 선택 시 예약 반영 필드가 활성화됩니다.
예약 반영 *	유예 기간을 예약반영으로 설정한 경우, 승인 완료 후 몇 일 뒤에 실행할지 예약할 수 있습니다.
공지 알림 *	공지 알림 내용을 작성합니다.
버튼	[승인 요청]: 승인 요청을 완료합니다. [취소]: 요청을 취소합니다.

항목

설명

유예기간 *

유예기간을 선택합니다.

즉시반영: 유예기간 없이 즉시 설정을 반영합니다. 해당 옵션 선택 시 예약 반영 필드는 비활성화됩니다.
예약반영: 특정 기간 경과 후 실행되도록 합니다. 해당 옵션 선택 시 예약 반영 필드가 활성화됩니다.

예약 반영 *

유예 기간을 예약반영으로 설정한 경우, 승인 완료 후 몇 일 뒤에 실행할지 예약할 수 있습니다.

공지 알림 *

공지 알림 내용을 작성합니다.

버튼

[승인 요청]: 승인 요청을 완료합니다.
[취소]: 요청을 취소합니다.

[승인 요청] 버튼을 클릭하여 승인 요청을 완료합니다.
- 수정 승인 요청을 하는 즉시 상세 화면의 [삭제] 버튼은 비활성화 상태의 [업데이트 예정] 버튼으로 변경됩니다.
- 수정 요청을 하는 즉시 상세 화면의 [운영 중지] 또는 [운영 개시] 버튼은 노출되지 않으며 편집 모드로 진입이 불가능합니다.
  
  단, 수정 승인 과정 중에 반려 또는 취소(신청 취소, 승인 취소)가 발생하여 해당 신청 건의 종결 처리가 될 때에는 [업데이트 예정] 버튼은 [삭제] 버튼으로 복구되며 [운영 중지] 또는 [운영 개시] 버튼 노출 및 정보 수정이 가능해집니다.
운영 관리 > 승인 관리 메뉴에서 포털 관리자는 자신의 승인 순서가 되면 승인 처리(승인, 반려, 승인 취소)를 진행합니다.
대표 승인라인의 포털 관리자들에 의해 모든 승인 처리가 완료되는 즉시 사용자 포털에 공지 알림이 등록됩니다.
- 사용자 포털 화면의 API 상세정보 > 업데이트 공지 탭에 공지 업데이트
알림 메시지 화면에서 입력한 유예기간이 완료(승인완료 시점부터 유예기간 계산)되면 해당 API는 자동으로 수정 정보가 업데이트됩니다.
업데이트가 완료되면 [업데이트 예정] 버튼은 [삭제] 버튼으로 변경되고 [운영 중지] 또는 [운영 개시] 버튼이 노출됩니다. 편집 모드로 진입할 수 있습니다.

수정 프로세스는 수정을 승인요청하는 시점에 API 사용자가 없더라도 동일하게 진행됩니다.

API 운영 중지 및 개시

API 운영 중지

API를 '운영 중지' 상태로 변경합니다. API 운영 중지 프로세스는 API 수정, 삭제 프로세스와 동일하게 예약 프로세스(승인 과정 및 유예기간)로 진행됩니다.

해당 API가 운영중인 경우에만 버튼이 노출되며, 현재 API가 삭제 예정, 업데이트 예정 상태인 경우에는 [운영 중지] 버튼은 노출되지 않습니다.
'운영 중지' 상태가 되는 시점에 해당 API를 이용 중인 사용자가 아직 있더라도 '운영 중지' 상태로 변경됩니다.

현재 '운영중' 상태인 API 상세 화면에서 [운영 중지] 버튼을 클릭합니다.
알림 메시지 화면이 나타나면 유예기간 설정 및 공지 알림을 작성 후 [승인 요청] 버튼을 클릭합니다. 알림 메시지 화면에서의 설정 방법 및 자세한 설명은 알림 메시지 설정을 참고합니다.
- 운영 중지 승인 요청을 하는 즉시 [운영 중지] 버튼은 비활성화 상태의 [운영 중지 예정] 버튼으로 변경됩니다.
- 운영 중지 승인 요청을 하는 즉시 [삭제] 버튼은 노출되지 않으며 편집 모드로 진입이 불가능합니다.
  
  단, 운영 중지 승인 과정 중에 반려 또는 취소(신청 취소, 승인 취소)가 발생하여 해당 신청 건의 종결 처리가 될 때에는 [운영 중지 예정] 버튼은 [운영 중지] 버튼으로 복구되며 [삭제] 버튼 노출 및 정보 수정이 가능해집니다.
운영 관리 > 승인 관리 메뉴에서 포털 관리자가 승인 처리(승인, 반려, 승인 취소)를 진행합니다.
대표 승인라인의 포털 관리자들에 의해 모든 승인 처리가 완료되는 즉시 사용자 포털에 공지 알림이 등록됩니다.
- 사용자 포털 화면의 API 상세정보 > 업데이트 공지 탭에 공지 업데이트
- 사용자 포털 화면의 서비스 상세정보 > 업데이트 공지 탭에 공지 업데이트
알림 메시지 화면에서 입력한 유예기간이 완료(승인완료 시점부터 유예기간 계산)되면 해당 API는 자동으로 '운영 중지' 상태가 됩니다.

'운영 중지' 상태가 되면 자동으로 이용 불가 상태가 되며, 사용자 포털 화면에서 해당 API의 [이용 신청] 버튼이 [신청 불가]로 변경됩니다.

API 운영 개시

API를 '운영중' 상태로 변경합니다. API 수정, 삭제 프로세스와 동일하게 예약 프로세스(승인 과정 및 유예기간)로 진행됩니다.

해당 API가 '운영 중지'인 경우에만 버튼이 노출되며, 현재 API가 삭제 예정, 업데이트 예정 상태인 경우에는 [운영 개시] 버튼은 노출되지 않습니다.
운영 개시 프로세스는 운영 개시를 승인 요청하는 시점에 API 사용자가 없더라도 동일하게 진행됩니다.

현재 '운영 중지' 상태인 API 상세 화면에서 [운영 개시] 버튼을 클릭합니다.
알림 메시지 화면이 나타나면 유예기간 설정 및 공지 알림을 작성 후 [승인 요청] 버튼을 클릭합니다. 알림 메시지 화면에서의 설정 방법 및 자세한 설명은 알림 메시지 설정을 참고합니다.
- 운영 개시 승인 요청을 하는 즉시 [운영 개시] 버튼은 비활성화 상태의 [운영 개시 예정] 버튼으로 변경됩니다.
- 운영 개시 승인 요청을 하는 즉시 [삭제] 버튼은 노출되지 않으며 편집 모드로 진입이 불가능합니다.
  
  단, 운영 개시 승인 과정 중에 반려 또는 취소(신청 취소, 승인 취소)가 발생하여 해당 신청 건의 종결 처리가 될 때에는 [운영 개시 예정] 버튼은 [운영 개시] 버튼으로 복구되며 [삭제] 버튼 노출 및 정보 수정이 가능해집니다.
운영 관리 > 승인 관리 메뉴에서 포털 관리자가 승인 처리(승인, 반려, 승인 취소)를 진행합니다.
대표 승인라인의 포털 관리자들에 의해 모든 승인 처리가 완료되는 즉시 사용자 포털에 공지 알림이 등록됩니다.
- 사용자 포털 화면의 API 상세정보 > 업데이트 공지 탭에 공지 업데이트
- 사용자 포털 화면의 서비스 상세정보 > 업데이트 공지 탭에 공지 업데이트
알림 메시지 화면에서 입력한 유예기간이 완료(승인완료 시점부터 유예기간 계산)되면 해당 API는 자동으로 '운영 중' 상태가 되며, 사용자 포털 화면에서는해당 API의 [신청 불가] 버튼이 [이용 신청]으로 변경됩니다.

API 삭제

등록된 API를 삭제합니다. API 삭제는 API 수정, 운영 중지, 운영 개시 신청과 동일하게 예약 프로세스(승인 + 유예기간)로 진행됩니다.

업데이트 예정 상태에서는 [삭제] 버튼이 [업데이트 예정]으로 변경되어 삭제 신청이 불가능합니다.
삭제를 승인요청하는 시점에 API 사용자가 없더라도 동일하게 진행됩니다.

[운영 관리] > [API 관리] 메뉴를 클릭합니다.
목록에서 원하는 API 항목을 클릭하면 API 상세 페이지가 열립니다.
API 상세 화면에서 [삭제] 버튼을 클릭합니다.
알림 메시지 화면이 나타나면 유예기간 설정 및 공지 알림을 작성 후 [승인요청] 버튼을 클릭합니다. 알림 메시지 화면에서의 설정 방법 및 자세한 설명은 알림 메시지 설정을 참고합니다.
- 삭제 승인 요청을 하는 즉시 [삭제] 버튼은 비활성화 상태의 [삭제 예정] 버튼으로 변경됩니다.
- 삭제 요청을 하는 즉시 [운영 중지] 또는 [운영 개시] 버튼은 노출되지 않으며 편집 모드로 진입이 불가능합니다.
  
  단, 삭제 승인 과정 중에 반려 또는 취소(신청 취소, 승인 취소)가 발생하여 해당 신청 건의 종결 처리가 될 때에는 [삭제 예정] 버튼은 [삭제] 버튼으로 복구되며 [운영 중지] 또는 [운영 개시] 버튼 노출 및 정보 수정이 가능해집니다.
운영 관리 > 승인 관리 메뉴에서 포털 관리자는 승인 처리(승인, 반려, 승인 취소)를 진행합니다.
대표 승인라인의 포털 관리자들에 의해 모든 승인 처리가 완료되는 즉시 사용자 포털에 공지 알림이 등록됩니다.
- 사용자 포털 화면의 API 상세정보 > 업데이트 공지 탭에 공지 업데이트
- 사용자 포털 화면의 서비스 상세정보 > 업데이트 공지 탭에 공지 업데이트
알림 메시지 화면에서 입력한 유예기간이 완료(승인완료 시점부터 유예기간 계산)되면 해당 API는 자동으로 삭제됩니다.

삭제된 정보는 복구 불가능하므로 삭제 시 주의하시기 바랍니다.