본 문서에서는 API Portal Admin의 기능과 역할에 대해 소개합니다.
Index
Plan Control
•
API Portal Admin의 접속 권한과 API Monitoring에서 조회 가능한 기간은 구독하신 Plan에 의해 제어합니다.
Start API Portal Admin
1) API Portal Admin 접속 방법
•
API Portal으로 접속하는 방법은 두 가지가 있습니다.
◦
SyncTree Studio의 API Portal 버튼을 클릭하여 접속합니다.
◦
URL을 직접 입력하여 접속합니다.
2) API Portal Admin 초기 페이지
•
API Portal Admin 초기 페이지에서는 로그인을 할 수 있습니다.
3) API Portal Admin 계정 생성
•
API Portal Admin은 관리 목적 상 계정 생성이 제한되어 있습니다.
•
계정을 생성하는 방법은 아래의 두 가지 방법입니다.
◦
Studio에서 Root 계정으로 로그인 한 경우, API Portal을 클릭하면 API Portal Admin에 자동 로그인 됩니다. 로그아웃 한 이후 재 로그인 시 계정 정보는 Studio 계정과 같습니다.
◦
Root 계정으로 API Portal에 로그인한 이후, Management > Account의 Admin 탭에서 Create Admin으로 계정을 생성할 수 있습니다.
4) 메인 페이지 화면 소개
•
API Portal Admin에 로그인을 하면 아래와 같은 메인 페이지를 확인할 수 있습니다.
기능 | 설명 |
Logs | API의 사용량과 로그 메시지를 대시 보드 형태로 확인할 수 있습니다. |
My Page Button | 우측 상단의 사람 모양 아이콘을 클릭하면 API Portal에 로그인 한 계정의 정보 확인 및 비밀번호를 재설정 할 수 있습니다. |
APP | 우측 상단의 + Create App 버튼을 클릭하여 API Portal에 등록된 API를 App으로 구성하며, App 페이지에서는 생성된 App List를 보여줍니다. |
API | Studio에서 Production의 Active까지 Push한 Bizunit을 우측 상단의 + Create API 버튼을 클릭하여 API Portal에 배포합니다. |
Management | API Portal과 계정, 사용량 제어 등을 관리하는 페이지입니다. |
Deploy * | 개발 환경에서 작업한 내역을 운영 환경으로 배포할 때, 결재권자의 승인을 받는 기능입니다. |
Deploy는 솔루션 공급 방식에 따라 제한적으로 제공됩니다.
API
1) API 생성
•
API 메뉴의 우측 상단 + Create API 버튼을 통해 Create API 페이지로 진입합니다.
•
API Portal을 통해 배포할 BizUnit은 API Resources에서 API 그룹으로 묶어서 배포할 수 있습니다.
◦
API Name : API Portal 내부에서 관리하는 이름입니다.
◦
Display Name : API Portal에서 사용자에게 대외적으로 노출되는 이름입니다.
◦
Descriprion : API의 설명 문구입니다. 줄바꿈이 가능하며 1,000자 까지 지원합니다.
2) API List
•
API 초기 페이지에서 배포한 API 리스트를 확인할 수 있습니다.
•
API Resources에서 해당 API에 등록된 API resource의 정보를 확인할 수 있습니다.
•
Status가 deactive되면 EndUser가 사용하는 API Portal에 해당 API가 노출되지 않습니다.
3) API Detail
•
각 API 상세 페이지에서 API 정보를 확인하고 API Resources를 수정할 수 있습니다.
•
Delete 버튼을 클릭하면 확인 알림창이 노출됩니다. 삭제를 진행하면 API Portal에 등록된 API도 삭제됩니다.
•
Testing Anonymously를 활성화 하면 API Portal에 로그인 하지 않더라도 API를 테스트해 볼 수 있습니다.
APP
1) APP 생성
•
APP 메뉴의 우측 상단 + Create App 버튼을 통해 Create App 페이지로 진입합니다.
•
API Portal을 통해 배포한 API 중 APP으로 묶을 API를 선택한 후 이름과 설명을 작성한 후 APP을 생성합니다.
2) APP List
•
API Portal과 API Portal Admin에서 생성된 모든 APP의 내역과 정보를 확인할 수 있습니다.
•
각 APP을 클릭하면 APP의 상세 페이지로 진입합니다.
3) APP Detail
•
APP의 정보와 Credential, 등록된 API 리스트를 확인할 수 있습니다.
•
Modify를 클릭하여 App 정보를 수정할 수 있습니다.
•
App 수정 페이지에서 해당 App에 등록된 API를 호출하기 위한 인증 Credential을 생성할 수 있습니다.
API Portal Management
1) API Monitoring
•
API의 사용량과 로그 메시지를 대시 보드 형태로 확인할 수 있습니다.
No. | 기능 |
1 | Monitoring할 APP 또는 API를 선택하는 영역입니다. |
2 | 모니터링 기간을 선택하거나 직접 입력할 수 있습니다. |
3 | Status와 latency를 검색 조건으로 선택할 수 있습니다. |
4 | API Monitorin결과 데이터를 확인합니다. |
2) API Management
(1) Portal
•
API Portal Admin과 API Portal의 링크를 확인할 수 있고, Portal의 이름과 설명을 수정할 수 있습니다.
(2) Account
•
API Portal Admin과 API Portal의 User 정보를 확인할 수 있으며, 생성 조건은 아래와 같습니다.
계정 | 사용 위치 | 목적 | 생성 주체 |
Admin | API Portal Admin | API 생성 및 관리 | Root 계정 |
User | API Portal | API 명세 확인 및 Test | EndUser |
API Portal Admin과 API Portal 계정은 서로 연동되지 않습니다.
(3) Rate Limit
•
API의 호출량을 제어해 과도한 트래픽으로부터 서비스를 안정적으로 운영할 수 있습니다.
•
Search바를 통해 API 이름과 설명 문구로 검색할 수 있습니다.
•
Rate Limit 버튼을 클릭하여 노출되는 팝업에서 TPS(1초/요청 횟수)를 설정할 수 있습니다.
1분 당 요청 횟수(1초 당 요청 횟수)로 표시되며, 기본값인 unlimited는 무제한 요청입니다.
•
TPS 값 이상 초과 요청 시, 429 Too many Request를 반환하며 요청이 제한됩니다.
