My Application은 APIM 개발자포털 사용자의 작업 공간 입니다. 멤버를 추가하고, API 사용 요청을 통해 API URL을 발급 받고, API KEY, Swagger UI를 통해 API Test를 수행합니다.
My Application의 화면 구성은 다음과 같습니다.
- 기본 정보 : Application 이름, Application 아이콘을 설정 합니다. 미사용 Application을 삭제할 수도 있습니다.
- API KEY : API 호출 시 인증 수행을 위한 API KEY를 의미 합니다. Application 생성 시 자동 발급되고, “App. 관리자”가 재발급 받을 수 있습니다.
- API 사용 : 사용하고자 하는 API를 선택하고, API 사용 목적을 입력하고, API 사용 요청을 합니다. 요청이 승인되면 API를 호출할 수 있는 API URL을 발급받게 됩니다.
- 멤버 관리 : Application의 멤버를 추가 합니다. 추가한 멤버에 대한 “App. 관리자” 권한을 부여합니다.
- IP/Referer Whitelist : API 호출 시 제한된 출발지의 IP/Referer Whitelist에 대해서만 API 호출이 가능하고, 그 외의 호출은 차단하는 기능을 제공합니다.
My Application - 기본 정보
Application 이름, Application 아이콘을 설정 합니다. 미사용 Application을 삭제할 수도 있습니다.
화면 구성은 다음과 같습니다.
- My Application - “기본 정보” 메뉴를 통해 “Application 기본 정보” 화면으로 이동 합니다.
- Application의 이름, AppID, 생성일을 확인할 수 있습니다.
- “Application 이름”을 변경 할 수 있습니다.
- “Application 아이콘”을 설정/변경할 수 있습니다.
- “Application 기본 정보” 화면의 설정을 저장합니다. “App. 관리자”는 Application을 삭제할 수도 있습니다.
My Application - API KEY
API 호출 시 인증 수행을 위한 API KEY를 의미 합니다. Application 생성 시 자동 발급되고, “App. 관리자”가 재발급 받을 수 있습니다.
API KEY는 API 호출 시 필수로 적용해야 합니다. 그렇지 않으면 인증 미수행으로 API 호출이 실패하게 됩니다.
화면 구성은 다음과 같습니다.
- My Application - “API KEY” 메뉴를 통해 “API KEY” 화면으로 이동 합니다.
- Application 생성 시 자동 발급되는 최초 API KEY를 확인할 수 있습니다.
- API KEY는 HTTP 요청 시, 요청 Header에 { “x-apim-key”: “xxxxxxxx” } 의 형태로 설정합니다.
My Application - API 사용
사용하고자 하는 API를 선택하고, API 사용 목적을 입력하고, API 사용 요청을 합니다. 요청이 승인되면 API를 호출할 수 있는 API URL을 발급받게 됩니다.
API 사용을 위해 다음을 수행 합니다.
- My Application - “API 사용” 메뉴를 통해 “API 사용” 화면으로 이동 합니다.
- “추가” 버튼을 통해 어떤 API를 사용 요청할 지 선택 합니다.
“사용승인요청” 팝업 입니다.
- 사용할 API를 체크 버튼을 통해 선택 합니다. 여러 개 선택이 가능 합니다.
- 사용할 목적 및 설명을 입력합니다.
- “확인” 버튼을 통해 API 사용 요청을 최종 수행 하게 되고, 이 후는 API 사용 요청에 대한 “대기” 상태가 됩니다.
API 사용 요청 이후 화면 입니다.
- API 사용 요청에 대한 “대기” 상태를 표시 합니다. API 관리자에게 API 사용 요청 알림이 전달된 상태이므로 승인 까지 대기 합니다.
- API 사용 요청에 대하여 API 관리자의 사용 승인 시 “대기” 상태가 “완료” 상태로 변경됩니다.
- API 호출이 가능한 API URL을 발급받게 됩니다.
- API 문서에 해당하는 Swagger 화면으로 이동하고, Swagger를 통해서 API 호출 Test가 가능합니다.
- API 사용 요청을 취소하거나, 이미 사용 승인 “완료”된 API를 삭제할 수 있습니다.
“삭제” 시, 발급 받은 API URL은 더 이상 사용할 수 없음에 주의해야 합니다.
API Test - Swagger UI
API 문서는 Swagger 기반으로 제공되며, Swagger > Try it Out > Execute 를 통해 API 호출 Test를 수행합니다.
Swagger 기반 API 호출 테스트 방법 입니다.
- My Application - API KEY 메뉴를 통해 “API KEY” 화면의 “API KEY” 값을 “복사” 합니다.
- Swagger “Authorize” 버튼을 통해 복사한 “API KEY” 값을 입력 설정 합니다.
- 호출하기 위한 API Method, Path를 선택하고, Try it Out > Execute를 통해 호출 합니다.
API KEY는 API 호출 시 필수로 적용해야 합니다. 그렇지 않으면 인증 미수행으로 API 호출이 실패하게 됩니다.
My Application - 멤버 관리
Application의 멤버를 추가 합니다. 추가한 멤버에 대한 “App. 관리자” 권한을 부여합니다. 최초 Application을 생성한 사용자는 기본 권한으로 “App. 관리자” 권한이 부여 됩니다.
My Application의 멤버 추가 및 관리자 권한 부여 방법은 다음과 같습니다.
- My Application - “멤버 관리” 메뉴를 통해 “멤버 관리” 화면으로 이동 합니다.
- 최초 Application을 생성한 사용자에게 기본 권한으로 “App. 관리자” 권한이 부여된 모습 입니다.
- “추가” 버튼을 통해 Application에 멤버를 추가 합니다.
추가할 멤버는 APIM 개발자포털에 회원가입한 아이디 중에서만 추가가 가능합니다. 멤버로 추가될 사용자에게 APIM 개발자포털 회원 가입이 선행되도록 안내 바랍니다.
- 추가할 멤버를 선택합니다. 여러 사용자를 선택할 수 있습니다.
- “확인”을 통해 최종 멤버 추가를 완료 합니다.
추가할 멤버의 사용자 아이디를 정확히 확인하여 잘못된 사용자에 대한 추가를 방지해야 합니다.
- 추가된 멤버를 확인할 수 있고,
- 추가된 멤버에 대하여 “App. 관리자” 권한을 부여할 수 있습니다.
- 추가된 멤버를 다시 멤버에서 제외 시킬 수도 있습니다.
“App. 관리자”는 다음의 권한이 부여 됩니다. 이에 주의하여 권한을 부여해야 합니다.
- “기본 정보” 화면의 Application 이름/아이콘 변경, Application 삭제
- “API KEY” 화면의 “재발급
- “API 사용” 화면의 사용할 API “추가”를 통한 API 사용 요청, API 사용 요청 삭제
- “멤버 관리” 화면에서 다른 사용자를 멤버로 “추가”, “제거”, “App. 관리자” 권한 부여
My Application - IP/Referer Whitelist
API 호출 시 제한된 출발지의 IP/Referer Whitelist에 대해서만 API 호출이 가능하고, 그 외의 호출은 차단하는 기능을 제공합니다.
IP 또는 Referer를 설정하여 API 호출 시 출발지 범위를 제한하는 방법입니다.
- My Application - “IP/Referer Whitelist” 메뉴를 통해 “IP/Referer Whitelist” 화면으로 이동 합니다.
- “추가”를 클릭하여 IP/Referer 입력창을 추가합니다
- IPv4 CIDR 형식을 입력합니다.
- 입력한 “IPv4 CIDR”에 대한 설명을 추가하여 어떤 출발지에 대한 IPv4 CIDR인지 기록합니다.
- “Active” 체크 상태인 경우에만 체크한 출발지 범위를 제한 합니다. “Active” 상태 변경 시 반드시 “저장” 바랍니다.
- 입력한 “IPv4 CIDR” 정보를 저장합니다. 저장 시 “Active” 상태인 항목이 실제 적용 됩니다.
- 입력한 “IPv4 CIDR” 정보를 삭제합니다. 삭제 후 “저장”이 필요합니다.