관리 포털 가이드

새 계정을 생성한 후에는 다음 단계를 통해 회사 정보를 추가합니다.

여기에서 지정한 주소에는 다음 두 가지 전략이 있습니다.

동일한 페이지에서 모든 시스템 디스플레이에서 사용할 시간대를 선택할 수도 있습니다. 이 설정은 분석 그래프에 영향을 미칩니다. 그러나 청구 주기 계산은 UTC 시간에 따라 수행됩니다.

3scale은 멤버 및 관리자를 위해 (SS0)에서 단일 기호 인증을 지원합니다.

3scale 관리 포털은 각각 여러 ID 중개 및 멤버 페더레이션 옵션을 지원하는 다음 SSO 공급자를 지원합니다.

RH-SSO 또는 Auth0에 추가된 사용자만 SSO를 통해 3scale 관리 포털에 액세스할 수 있습니다. 역할 또는 사용자 그룹에 의한 액세스를 추가로 제한하려면 RH-SSO 또는 Auth0 지원 포털에서 해당 단계를 단계별로 참조해야 합니다.

선택한 공급자를 통해 SSO를 설정한 후에는 3scale 관리 포털에서 구성하고 활성화해야 합니다.

SSO를 구성한 경우, 구성원은 연결된 IdM(Identity Provider)에서 계정 자격 증명을 사용하여 로그인할 수 있습니다.

다음 단계에 따라 SSO를 사용하여 3scale 관리 포털에 로그인합니다.

성공적으로 등록하면 API 공급자 조직 아래에 멤버 계정이 있고 자동으로 로그인됩니다.

이 섹션에서는 RH-SSO를 통해 IdM(Identity Provider) 로그인 창으로의 리디렉션에 대해 설명합니다. 3scale API Management 관리자는 3scale 계정에 선택적 SSO(Single Sign-On) 로그인 페이지를 통해 액세스할 수 있도록 하려면 다음 단계를 완료합니다.

3scale 설치 사용자 목록을 보려면 관리 포털 페이지의 다음 단계를 따르십시오.

사용자 목록에서 새 팀 멤버를 초대할 수 있습니다. 초대를 보내려면:

입력한 주소로 초대 이메일이 전송됩니다. 이메일이 도착하지 않으면 수신자의 이메일 계정에 스팸으로 표시되지 않았는지 확인하십시오.

또한 사용자 > 초대에서 전송된 초대의 목록 및 상태를 확인할 수 있습니다.

새 관리자 또는 멤버는 초대 이메일의 링크를 클릭하고 프로세스를 완료하려면 양식을 작성해야 합니다. 양식을 제출하면 해당 계정이 활성화됩니다.

팀 멤버에게 제공할 수 있는 두 가지 주요 유형의 권리가 있습니다.

새 사용자 권한을 부여하려면 사용자 메뉴에서 해당 권한을 선택하고 편집 을 클릭하여 새 사용자를 편집합니다. 다음과 같은 사용자 역할이 있습니다.

관리 포털의 특정 영역에 대한 액세스 권한을 부여하면 구성원에게 동등한 API에만 액세스할 수 있습니다.

다양한 유형의 알림이 있습니다.

admin 사용자는 모든 알림에 액세스할 수 있습니다.

멤버 사용자는 액세스 권한이 부여된 영역의 알림에만 액세스할 수 있습니다. 예를 들어, 멤버는 청구 섹션에 액세스할 수 있는 경우에만 청구와 관련된 알림에 액세스할 수 있습니다.

엔터프라이즈 계정 의 경우 멤버 사용자는 액세스 권한이 부여된 서비스 활동에 대한 알림만 액세스할 수 있습니다.

서브스크립션은 개인 정보이며 해당 알림을 수신하는 사용자만 수정할 수 있습니다. 서브스크립션을 편집하려면 다음을 수행합니다.

이메일 알림 외에도 대시보드에서 마지막 활동에 대한 정보를 찾을 수 있습니다.

액세스 토큰을 사용하면 API 공급자 관리자 및 멤버가 3scale API(임의, 계정 관리, analytics)에 대해 인증하고 ActiveDocs(대화형 문서)를 사용하여 해당 API를 사용해 볼 수 있습니다.

액세스 토큰은 읽기 및 쓰기 액세스 또는 읽기 전용을 제공할 수 있습니다.

고려해야 할 중요한 사항은 액세스 토큰이 작동하는 방식이며, 이는 해당 멤버의 권한에 따라 이루어집니다. 관리자는 3scale API 모두에 대해 인증하기 위한 토큰을 생성할 수 있습니다. 멤버는 관리 포털의 다른 부분에 액세스할 수 있는 권한으로 제한됩니다. 예를 들어 멤버가 LimitRangeing 영역에 액세스할 수 없는 경우Membering API에 대해 인증하기 위해 토큰을 만들 수 없습니다.

액세스 토큰은 토큰 페이지에서 생성할 수 있습니다. 토큰을 생성하려면 다음 단계를 따르십시오.

멤버인 경우 계정 관리자가 액세스할 수 있는 API만 모든 API가 표시되지 않을 수 있습니다.

필요한 만큼의 액세스 토큰을 생성할 수 있습니다. 보안상의 이유로 토큰이 3scale에 저장되지 않습니다. 새 토큰을 생성할 때 토큰을 저장하라는 경고 메시지가 표시되므로 이 토큰을 사용하여 3scale API에 요청할 수 있습니다.

토큰이 손실되면 삭제하는 것이 좋습니다.이를 삭제하면 비활성화되고 유효하지 않게 렌더링됩니다. 새 토큰을 만드는 것이 좋습니다.

액세스 토큰을 사용하여 3scale API를 호출할 때 액세스 권한이 있는 서비스에 의해 결과가 필터링됩니다.

예를 들어 APIcast 자체 관리를 배포할 때 APIcast API 게이트웨이가 계정 관리 API를 사용하여 서비스 구성을 가져올 수 있도록 액세스 토큰이 필요합니다.

이 작동 방식은 조직이 3scale에서 3scale 서비스를 설정하는 경우이며, 멤버로 2 및 3에는 액세스할 수 있지만 계정 관리 API에 액세스할 수도 있습니다. 또한 토큰을 생성하고 계정 관리 API에 요청할 때 서비스 1을 사용하는 애플리케이션만 받습니다.

동일한 예제에 따라 계정 관리 API에 액세스할 수 있지만 제로 서비스에 액세스할 수 있는 경우 호출을 수행할 때 "액세스 거부됨" 오류가 발생합니다.

마스터 관리자는 마스터 관리 포털 및 API 엔드포인트를 통해 Red Hat 3scale API Management 계정을 모니터링하고 관리합니다. 표준 관리 포털 과 마찬가지로 마스터 관리 포털에는 배포의 모든 계정에 대한 정보가 포함되어 있으며 고유한 계정 페이지를 통해 계정 및 사용자를 관리할 수 있습니다.

계정 관리자 작업에 대한 자세한 내용은 계정 설정 가이드를 참조하십시오.

7.1.1. 마스터 관리 포털에 액세스

링크 복사

마스터 관리 포털에 액세스하려면 온-프레미스 설치 프로세스 중에 마스터 관리 포털에 대해 구체적으로 정의된 인증 정보 및 URL을 사용해야 합니다.

마스터 관리 포털 URL은 ECDHETER _NAME (기본적으로 템플릿에서master ) 및 WILDCARD_DOMAIN 으로 구성됩니다.

<MASTER_NAME>.<WILDCARD_DOMAIN>

Master 플래그로 마스터 관리 포털을 확인할 수 있습니다.

마스터 관리 포털 또는 API 호출을 통해 계정을 관리할 수 있습니다.

7.2.2. API 호출을 통해 계정 관리

링크 복사

Master Admin API 호출을 통해 계정을 관리할 수 있습니다. 이러한 호출에 대한 정보는 마스터 관리 포털의 오른쪽 상단에 있는 질문 표시(?) 아이콘을 클릭한 다음 3scale API Docs 를 선택하여 마스터 API 섹션을 참조하십시오.

동일한 OpenShift 클러스터 도메인 아래에 있는 여러 계정의 결과로 개별 계정 이름은 OpenShift 클러스터 도메인 이름을 하위 도메인으로 추가합니다. 예를 들어 example.com 도메인이 있는 클러스터에서 user 라는 계정 경로는 다음과 같이 표시됩니다.

user.example.com

표준 다중 테넌트 배포에는 다음이 포함됩니다.

마스터 관리자가 추가한 추가 계정에는 해당 이름에 따라 하위 도메인이 할당됩니다.

테넌트 계정을 다시 시작하면 삭제 예약된 계정을 복원해야 합니다. 삭제하도록 예약한 후 최대 15일 후에 테넌트 계정을 다시 시작할 수 있습니다.

계정을 다시 시작한 후 다음을 수행하십시오.

Service Discovery를 사용하면 동일한 OpenShift 클러스터에서 실행 중인 검색 가능한 API 서비스를 스캔하고 관련 API 정의를 3scale로 자동으로 가져올 수 있습니다.

API 통합 및 Open API Specification을 언제든지 업데이트한 후 클러스터와 다시 동기화할 수도 있습니다.

Service Discovery는 다음과 같은 기능을 제공합니다.

검색 가능한 서비스를 가져오면 해당 네임스페이스가 유지됩니다.

3scale 관리자는 OAuth 서버를 사용하거나 사용하지 않고 서비스 검색을 구성할 수 있습니다.

OpenAPI Specification (OAS, Swagger 사양이라고도 함)에 해당하는 새 API 서비스를 찾을 수 있습니다. 해당 서비스는 3scale 관리를 위해 클러스터에서 검색됩니다.

OpenShift 프로젝트 관리자는 OAuth 토큰이 유효하지 않은 경우 3scale 사용자가 네임스페이스에 액세스하도록 권한을 부여할 수 있습니다.

클러스터에서 서비스의 현재 정의를 사용하여 3scale에서 기존 API 서비스를 업데이트(refresh)할 수 있습니다.

제품 또는 백엔드에 새 방법을 추가하려면 다음 단계를 따르십시오.

나중에 메서드 정의를 변경할 수 있습니다. 메서드 이름(메서드 )을 클릭하고 필드를 업데이트하고 Update Method를 클릭합니다.

방법 및 메트릭의 시스템 이름 변경 또는 삭제에 매우 주의하십시오. 이러한 변경으로 인해 메서드의 이전 시스템 이름을 가리키는 매핑 규칙이 있는 경우 이미 배포된 3scale 통합을 중단할 수 있습니다.

새 지표를 생성하려면 New 지표 를 클릭하고 필요한 매개변수를 제공합니다. 단위를 지정할 때 단일 noun (예: "hit")을 사용합니다. analytics 차트에서 자동으로 복수형이기 때문입니다.

이러한 새로운 방법과 메트릭은 현재 및 향후의 모든 계획에서 사용할 수 있습니다. 이제 [gradle _product_name] > 애플리케이션 > 애플리케이션 계획 > [plan_you_want_to_edit]로 이동하여 각 계획에서 제한 및 가격 규칙을 편집할 수 있습니다.

API에 끝점이 많이 있는 경우 3scale에서 메서드 및 메트릭을 자동으로 생성하는 두 가지 추가 방법을 제공합니다.

기본적으로 3scale 계정이 생성되면 Basic 및 Unlimited의 두 가지 계획이 제공됩니다. 이러한 항목을 유지 및 편집하거나 직접 만들 수 있습니다. 필요한 만큼 계획을 생성할 수 있습니다.

새 애플리케이션 계획을 생성하려면 다음 단계를 따르십시오.

계획을 생성하면 속도 제한을 프로비저닝하고 유료 계획을 설정할 수 있습니다.

모든 계획을 생성한 후 사용자가 애플리케이션을 등록하기 위해 등록할 때 기본 계획을 선택할 수 있습니다.

기본 애플리케이션 계획을 선택하려면 다음을 수행합니다.

기본 애플리케이션 계획을 표시하지 않는 경우 새 사용자가 API에 대한 액세스 권한을 등록하면 기본적으로 애플리케이션을 생성하지 않습니다. 즉, 사용자는 API에 액세스할 수 없습니다.

첫 번째 결정은 가격 모델의 계층을 구별하는 방법입니다. 계층은 볼륨 또는 사용량, API 기능, 다른 리소스에 대한 액세스 또는 조합에 따라 구동될 수 있습니다.

가격 드라이버를 결정하면 계층이 플랫 속도 서브스크립션, 변수 속도 또는 일회 전하를 기반으로 할지 여부를 결정해야합니다. 위의 세 가지 가격 결정 드라이버는 모두 off 또는 monthly flat rate 서브스크립션과 호환됩니다. 가격을 결정하는 경우 히트 볼륨이나 리소스 소비량을 기준으로 결정되는 경우 가격에 대한 변수 요소가 있습니다.

새 애플리케이션 계획을 생성하거나 기존 애플리케이션을 편집할 수 있습니다. 새 애플리케이션 계획을 생성할 때 초기 비용 또는 플랫 비율 서브스크립션을 입력할 수 있습니다.

편집 애플리케이션 보기에서 초기 비용 및 서브스크립션을 입력하거나 수정할 수 있습니다.

다음으로 12.1절. “가격 모델 결정” 에서 선택한 가격 드라이버를 설정합니다.

일부 항목이 메트릭으로 이미 있는 경우 항목을 편집할 수 있습니다.

가격 책정 규칙 설정을 완료하면 애플리케이션 업데이트 계획 을 클릭합니다.

단일 애플리케이션 계획을 사용하여 API 유료 계획을 정의할 수 있습니다. 일반적으로 모든 가격 책정 규칙이 볼륨 또는 리소스 드라이버에 의해 정의되는 경우입니다. 그러나 개발자 커뮤니티의 다른 세그먼트에 대해 별도의 계획을 제공하려면 더 많은 애플리케이션 계획을 추가합니다.

가장 쉬운 방법은 애플리케이션 계획 개요 페이지에서 첫 번째 애플리케이션 계획을 복사하는 것입니다. 이렇게 하면 기존 메트릭 및 가격 규칙이 모두 미리 채워집니다. 처음으로 전체 계획을 만들기 위해 더 많은 주의를 기울이면 계획 복사 기능으로 더 많은 시간을 절약할 수 있습니다.

계획을 프로비저닝하려면 개발자가 새 애플리케이션을 생성하고 새 유료 계획 중 하나를 선택해야 합니다. 관리 콘솔에서 이 작업을 수행할 수도 있습니다. 기존 애플리케이션의 경우 기존 계획에서 새 유료 계획 중 하나로 변경할 수도 있습니다.

플랫 비율 계획과 함께 속도 제한을 사용하여 계층을 구별하는 것이 일반적입니다. 이는 프로비저닝 속도 제한에서 설명됩니다.

애플리케이션 계획이 아직 정의되어 있지 않은 경우 먼저 생성합니다. 그렇지 않으면 속도 제한을 설정할 계획을 선택하고 편집 을 클릭합니다.

애플리케이션 계획 생성에 대한 자세한 내용은 애플리케이션 계획을 참조하십시오.

속도 제한을 설정하려면 다음을 수행합니다.

이제 비율 제한이 정의되었으므로 다음이 수행됩니다.

속도 제한이 작동하면 대시보드의 한도에 도달하는 사용자를 볼 수 있으므로 잠재적인 계획 업그레이드 후보를 빠르고 쉽게 확인할 수 있습니다. 소프트 및 하드 제한에 대한 자세한 내용은 고급 경로의 애플리케이션 계획으로 API 액세스 정책 구성에서 시작하기 가이드를 참조하십시오.

속도 제한을 설정하는 것 외에도 동일한 메트릭에 대한 변수 가격 규칙을 설정할 수도 있습니다.

3scale에 대한 청구는 일정 월에 기반하며 Prepaid and *Postpaid 일 수 있습니다.

자세한 내용은 Automated billing process 를 참조하십시오.

이 설정은 카드 거래를 가능하게 합니다. 이 설정이 설정되어 있으면 선택한 결제 게이트웨이를 사용하여 모든 송장이 청구됩니다. 이 설정을 해제하면 청구가 발생하고 송장이 발행되지만 실제 결제 거래는 발생하지 않습니다.

청구 및 카드 거래를 수행할 통화를 선택합니다. 귀하의 결제 게이트웨이에 의해 선택된 통화가 지원되는지 확인하십시오. 이 설정은 글로벌이며 모든 송장 및 트랜잭션에 적용됩니다. 다른 개발자 계정에 대해 다른 설정을 설정할 수 없습니다.

Invoice footnote 필드에 도입된 텍스트는 모든 IRQ 송장 하단에 표시됩니다. 이 필드를 사용하여 고객의 배당 및 청구 정책에 대한 추가 정보를 제공할 수 있습니다.

각주의 텍스트가 변경되면 IRQ가 이미 생성된 송장에는 자동으로 적용되지 않습니다. 그러나 송장의 IRQ를 다시 생성하여 변경 사항을 적용할 수 있습니다.

이 필드는 청구된 계정의 경우 IRQ 송장에 텍스트 메시지를 추가하는 데 사용됩니다. 이 행은ECDHE / Sales hieradata가 명시적으로 0으로 설정된 경우에만 표시됩니다. 그렇지 않으면 표시되지 않습니다. 이 텍스트는 관리 포털의 송장 페이지에도 표시됩니다.

이 설정에 대한 자세한 내용은 please see more about this setting inECDHE / SalesECDHE 섹션에서 참조하십시오.

3scale의 송장에는 두 가지 유형의 ID가 있습니다.

이 설정은 송장의 Friendly ID 형식을 정의합니다.

송장 ID에 대한 billinging 기간을 월간 에서 연간 로 변경하는 유일한 영향은 친숙한 ID 형식을 변경하는 것이며 청구 주기 기간은 변경되지 않습니다. 3scale API Management에서 월간 청구만 지원됩니다. 회계 부서에서 이러한 요구사항이 있는 경우 송장 ID의 형식을 연간로 변경할 수 있습니다.

연간 요금을 청구해야 하는 경우 청구를 수동으로 처리해야 합니다. 새 송장을 생성하고 연간 비용으로 라인 항목을 추가할 수 있습니다. 연간 배당을 사용하려는 경우 애플리케이션 계획을 자유롭게 설정하여 송장이 생성되지 않도록 하고/또는 매달 자동으로 청구되도록 할 수 있습니다.

여기에서 다음 페이지의 경로를 구성할 수 있습니다.

3scale은 카드 거래를 위해 다음과 같은 결제 게이트웨이와 통합됩니다.

14.8.1. 스트라이프 통합(권장)

링크 복사

이 단계를 완료하면 계정에 대한 결제 게이트웨이로 Stripe을 구성하게 됩니다. 이를 통해 개발자는 귀하의 카드 정보를 입력할 수 있으며 계산된 송장에 따라 Stripe을 통해 자동으로 API에 액세스할 수 있습니다.

유료 API에 대해 대금 카드 과충을 활성화하는 경우 한 가지 주요 단계는 결제 게이트웨이를 설정하는 것입니다. 3scale 계정과 함께 사용할 수 있는 대체 결제 게이트웨이가 여러 가지가 있습니다. 여기에서는 Stripe의 단계를 다룹니다.

14.8.1.1. 사전 요구 사항

링크 복사

이러한 단계를 시작하기 전에 Stripe 계정을 열어야 합니다.

14.8.1.2. Stripe에서 API 키 가져오기

링크 복사

Stripe 계정에 로그인하고 https://dashboard.stripe.com/account/apikeys 에서 API 키를 가져옵니다. 두 개의 키가 필요합니다. "비밀" 1과 "공개" 1개입니다. 테스트를 수행할 때 "테스트" 세트와 "라이프트"를 시작할 준비가 되면 "라이브" 세트를 사용하십시오.

14.8.1.3. 3scale에서 설정 구성

링크 복사

이러한 API 키 사용을 시작하도록 3scale에 지시해야 합니다. 이렇게 하려면 3scale 관리 포털에 로그인하고ECDHE > go to makeging & Gateway 로 이동합니다.

Enabled 플래그가 활성화되지 않은 경우 활성화한 후 저장을 클릭합니다.

페이지 하단에 게이트웨이라는 드롭다운이 표시되어야 합니다. Stripe로 변경하십시오.

드롭다운 아래의 양식은 두 개의 필드를 표시하도록 변경됩니다. Stripe API 키를 삽입하고 저장을 클릭합니다.

결제 게이트웨이를 변경할 때 몇 가지 경고가 표시될 수 있습니다. 이는 예상입니다. 내용을 읽고 나타나는 경우 이를 수락하십시오.

이제 결제 게이트웨이가 설정되어 있지만 사용자는 CMS에서 구성되지 않았기 때문에 아직 사용하지 못할 수 있습니다. 개발자 포털로 이동하여 왼쪽 탐색 창에서ECDHE Gateway / Show라는 템플릿을 클릭합니다.

아직 없는 경우 "braintree_blue" %} : {% 전에 다음 코드를 추가하십시오.

{% when "stripe" %}
 <p><a href="{{ current_account.edit_stripe_billing_address_url }}">Edit billing address</a></p>

 {% if current_account.has_billing_address? %}
   {% stripe_form "Edit Credit Card Details" %}
 {% else %}
   <p>After entering billing address, the option to enter credit card will be enabled.</p>
 {% endif %}

마지막으로 저장 및 게시를 클릭합니다. 이제 사용자가 Stripe 게이트웨이를 사용하여 비용을 결제할 수 있어야 합니다.

참고

3scale에서 데이터와 Stripe의 데이터를 매핑하려면 3scale-[PROVIDER_ID]-[DEVELOPER_ACCOUNT_ID]로 구성된 metadata.3scale_account_reference 라는 Stripe 필드를 사용할 수 있습니다.

14.8.2. Braintree 통합

링크 복사

이러한 단계는 API 사용을 청구하기 위해 Braintree 게이트웨이를 설정하는 단계입니다.

14.8.2.1. Braintree에서 API 키 가져오기

링크 복사

Braintree 로 계정을 개설해야 합니다. 게이트웨이 및 Merchant 계정 및 Vault가 필요합니다. 선택적인 추가 기능으로, USA Express 카드를 결제 방법으로 허용하도록 선택할 수 있습니다.

시작하려면 Braintree 계정에 로그인합니다. 그런 다음 계정 > MyUser 영역에서 API 키를 찾습니다.

API 키 페이지가 계속 개인 키를 숨기므로 볼 옵션을 선택합니다.

마지막으로 3scale 청구 설정에 필요한 공개 키, 개인 키 및 Merchant ID가 있습니다.

14.8.2.2. 3scale에서 설정 구성

링크 복사

이러한 API 키 사용을 시작하도록 3scale에 지시해야 합니다. 이렇게 하려면 3scale 관리 포털에 로그인하고ECDHE > tileing >ECDHEging & Gateway 로 이동합니다.

청구 페이지에 지정된 통화 유형이 Braintree 가맹점 계정에 사용된 통화 유형과 일치하는지 확인합니다.

Enabled 플래그가 활성화되지 않은 경우 활성화한 후 저장을 클릭합니다.

페이지 하단에 게이트웨이라는 드롭다운이 표시되어야 합니다. Braintree (Blue Platform)로 변경하십시오.

드롭다운 아래의 양식은 두 개의 필드를 표시하도록 변경됩니다. Braintree 키를 삽입하고 저장을 클릭합니다.

결제 게이트웨이를 변경할 때 몇 가지 경고가 표시될 수 있습니다. 이는 예상입니다. 표시되는 경우 읽고 수락하십시오.

이제 사용자는 Braintree 게이트웨이를 사용하여 비용을 청구할 수 있습니다.

참고

3scale의 데이터로 Braintree의 데이터를 매핑하려면 3scale-[PROVIDER_ID]-[DEVELOPER_ACCOUNT_ID]로 구성된 customer.id 라는 Braintree 필드를 사용할 수 있습니다.

14.8.2.2.1. 문제 해결

링크 복사

계정이 샌드 박스 모드에 있고 문제가 발생하는 경우 이를 production으로 변경해야 합니다.

가격 규칙은 각 API 요청 비용을 정의합니다. 동일한 메트릭에 대한 여러 가격 정책 규칙은 가격 규칙이 적용되는 경우의 범위를 나눕니다. 가격 규칙은 일정 월을 기반으로하며 카운터는 각 달의 첫 번째 날의 00:00 UTC로 재설정됩니다.

Until 100 calls per month (from 1 to 100) each API call can be charged at $0.04, and starting from the call 101 (from 101 to infinity) the calls are charged at $0.10.

The first 1000 calls are not charged (cost $0), because they are included in the plan which has a monthly fixed cost. Starting from call 1001, each call is charged at $0.50.

Calls from 1 to 100 are charged at $0.30, 100 to 500 – at $0.40, and 500 and further – at $0.50.

마지막 두 단계를 반복하여 필요한 모든 가격 규칙 범위를 만듭니다.

To 필드를 비워 두면 규칙을 "에서 무한"으로 설정합니다.

최대 10진수 수는 메트릭 비용의 경우 4로 설정됩니다. 숫자가 더 많은 10진수로 추가되면 10진수가 4개인 숫자로 반올림됩니다.

meeting > billing > Earning by month 섹션에서 상태에 따라 해당 월에 발행된 모든 송장의 합계로 계산되는 귀하의 여가 및 접수에 대한 개요를 확인할 수 있습니다.

특정 달을 클릭하면 해당 월에 대한 모든 송장을 나열할 수 있습니다.

또한 invoices 목록을 see the list of invoices by going to make your ID, where you can find invoices by their ID (friendly ID), 계정 이름, 달 및 상태별로 필터링 할 수 있습니다.

특정 개발자 계정의 송장은 IRQ > 계정 > 계정 > [선택된 계정] 에서 계정 세부 정보 페이지의 X Invoices 에서 확인할 수 있습니다. 여기서 X는 계정의 송장 수입니다.

송장 목록에서 송장 ID를 클릭하면 송장 세부 정보가 표시됩니다.

송장은 다음 상태 중 하나에 있을 수 있습니다.

3scale에서는 청구 프로세스가 매일 실행됩니다. 청구 흐름에 따라 송장을 생성하고, 상태를 변경하고, 구성된 결제 게이트웨이를 사용하여 요금을 수행합니다.

청구 흐름은 Prepaid 및 Postpaid 모드와 약간 다르며 3scale에서 청구가 일정 월에 따라 결정되므로 해당 월의 첫날에 발생하는 특별한 이벤트가 있습니다.

자동 청구 프로세스에서는 유료 서비스에 가입된 모든 개발자 계정에 대해 송장을 생성합니다. 배상은 전 세계적으로 활성화되거나 비활성화될 수 있습니다. 과금에 대한 자세한 내용은 청구 설정 구성을 참조하십시오.

개발자 계정당 청구 및 청구를 활성화하거나 비활성화할 수도 있습니다. 이러한 작업을 수행하려면 DestinationRule > Accounts > listing 로 이동하여 변경할 그룹/Org. 아래의 개발자 계정을 클릭한 다음 해당 버튼을 클릭합니다(/비활성화).

과금이 비활성화되고 청구가 활성화되면 개발자에게 송장이 발행되지만 청구는 청구되지 않습니다. 이 기능은 (예: 경유 전송)을 개별적으로 처리하는 경우에 유용합니다.

둘 다 비활성화되어 있는 경우 개발자는 발행되거나 청구되지 않습니다.

청구가 비활성화되고 과금이 활성화되면 개발자에게 새로운 송장이 발행되지 않지만 모든 미결한 항목(보류 중 및 실패)이 계속 부과됩니다.

여기 LimitRange ing Status 블록에 있는 경우 해당 카드 세부 정보가 계정에 구성되어 있는지도 확인할 수 있습니다. 카드 세부 정보가 설정되어 있는 경우 월 및 카드 만료 연도가 표시됩니다. 카드 세부 정보가 있으면 개발자 포털의 등록 및 계획 변경에 영향을 미칠 수 있습니다( 16.9절. “직불 카드 흐름”참조).

지정된 기간(일)에 대한 유예 기간(일)을 지연하기 위한 유료 계획에 대해 시험 기간(일)을 설정할 수 있습니다.

상태 열에서 애플리케이션의 평가판 기간 상태를 볼 수 있습니다. "live - trial expires in the trial period", and in the application details page in the Trial days left field.

시험 기간 동안 애플리케이션은 제한 없이 계획에 정의된 모든 기능 및 사용 제한을 사용할 수 있습니다.

시험 기간이 설정되면 취소 또는 연장할 수 없습니다. 다른 계획으로 업그레이드하면 시험일 카운터가 재설정되지 않습니다.

시험 기간이 만료되기 10일 전에는 향후 시험 만료를 알리는 개발자 계정으로 이메일 알림이 전송됩니다. 이 이메일의 템플릿은ECDHE > Messages > Email Templates 에서 구성할 수 있습니다. : 애플리케이션 계획에 대해"Application trial period expired for buyer ", and "Service trial period expired for the service plans with trial period". 개발자는 현재 계획을 유지하거나 다른 계획으로 전환하거나 서브스크립션을 취소하기로 결정한 경우 API 공급자에게 문의해야 합니다.

시험 기간이 끝나면 다음 시간 자동 청구 실행 ( 16.4절. “자동 청구 프로세스”참조) 개발자는 애플리케이션 또는 서비스가 현재 사용 중인 계획에 따라 비용이 청구됩니다. 이 애플리케이션은 시험 기간이 만료된 후에도 차단되거나 일시 중지 되지 않으며 계속 작동합니다.

기술적으로 시험 기간을 무료 계획에 설정할 수 있지만 기능이 유용성이 손실되므로 권장되지 않습니다.

VAT( VAT)는 유럽 연합 내에서 판매된 재화 및 서비스에 적용되는 세율입니다. 다른 국가에는 비슷한 세율이 있습니다(예: 판매세). API 서비스 사용을 위해 고객을 부과하는 API 공급자는 종종 세무를 부과하고 기존 규정을 준수하기 위해 송장에 반영해야 합니다.

3scale 청구는 구성된 경우 송장에 automatically included를 포함할 수 있습니다.

_Total cost (without <VAT rate>)_ +
_<VAT rate> Amount_ +
_Total cost (<VAT rate> <VAT rate value>% included)_

개발자는Create card information을 관리하고 개발자 포털에서 해당 송장을 볼 수 있습니다.

개발자가 개발자 포털의 청구 관련 요소를 볼 수 있도록 IRQ > 개발자 포털의 재무 전환 > 기능 gettingsible 상태가 될 수 있어야 합니다.

로그인한 사용자는 설정 > 대입 카드 세부 정보에서 직불 카드 세부 정보를 업데이트할 수 있습니다. 구성된 결제 게이트웨이에 따라 양식이 다를 수 있으며 사용자는 청구 주소를 먼저 입력해야 할 수 있습니다.

개발자는 개발자 포털에는 하나의 카드 카드만 가질 수 있습니다.

개발자 포털에서 개인 카드 세부 정보를 삭제할 수 없습니다. 카드 세부 정보를 삭제하려는 개발자 계정의 사용자는 API 공급자에게 시스템에서 email 카드 세부 정보를 삭제하도록 요청해야 합니다.

송장을 보려면 사용자가 Settings > Invoices 로 이동하여 각 송장에 대한 세부 정보를 표시하거나 invoice IRQ를 다운로드할 수 있습니다.

개발자가 개발자 포털의 email Card Details에 청구 주소를 입력하면 이 주소는 "legal" 계정 주소와 별도로 저장됩니다.

기본적으로 법률 주소는 발급 대상 필드의 송장에 표시됩니다. 그러나 개발자에게 법률 주소가 구성되어 있지 않지만 청구 주소만 있는 경우 후자의 송장에서 사용됩니다. 조직 이름은 이 경우 주소의 일부로 간주됩니다.

기본적으로 청구 주소는 관리 포털 또는 제품 API에 표시되지 않지만 다음과 같이 추가할 수 있습니다.

이제 계정 관리 API 및 Webhook에서 계정의 XML 모델에 < billing_address > 필드가 표시됩니다. 해당 청구 주소는 계정에서 읽기 전용으로 표시되고 관리자 포털의 계정 편집 페이지가 표시됩니다.

청구 주소는 개발자 포털의 개발자가 카드 세부 정보 섹션에서 변경할 수 있습니다. 관리자는 관리 포털에서 청구 주소를 변경할 수 없지만 다음 필드( "추가 필드")를 사용하여 계정 관리 API의 계정 편집 끝점을 사용하여 이렇게 할 수 있습니다.

billing_address_name
billing_address_address1
billing_address_address2
billing_address_country
billing_address_city
billing_address_state
billing_address_zip
billing_address_phone

3scale 계정(admins and members with billinging permission)은 계정 설정에서 청구 와 관련된 알림(상위 오른쪽의 아이콘) > 개인 > 알림 브릿지 섹션에서 구독하거나 구독 취소할 수 있습니다.

참고: 3scale 계정의 모든 관리자는 청구에 관한 알림을 받습니다.

개발자 계정으로 전송된 이메일 알림은ECDHE > Messages > Email Templates 에서 구성할 수 있습니다. 다음 이메일을 사용할 수 있습니다.

개발자 계정의 모든 관리자 사용자는 위의 알림을 받습니다.

관리자는 일부 필수 필드도 건너뛸 수 있습니다. 사용자를 안전하게 계정에 초대하려면 암호 필드를 건너뛸 수도 있습니다. 그러나 이 기본 관리자 계정의 이메일은 모든 사용자 간에 고유해야 합니다.

계정에 대한 앱 키를 미리 구성하려는 경우 개발자 대신 애플리케이션을 추가할 수도 있습니다. 그렇지 않으면 개발자가 수행할 초기 단계 중 하나로 두십시오.

개발자에게 이메일 초대를 수동으로 보내거나 단계에 따라 초대 개발자 기능을 사용할 수 있습니다.

개발자 중 하나에 승인이 보류 중인 항목이 있음을 알리는 이메일 알림을 수신하면 해당 항목의 URL을 브라우저로 복사하고 붙여넣을 수 있으며 승인을 위해 페이지로 직접 이동합니다.

특정 계정을 검색하거나 "종료"(승인을 위해) 상태에 있는 모든 계정을 필터링하려면 DestinationRule > Accounts > listing로 이동합니다. 보류 중인 계정만 표시하려면 State (상태) 목록에서 "Pending"를 선택하고 Search 를 클릭합니다.

각 행에서 직접 개별 승인을 수행하거나 한 번에 여러 행을 선택하고 대량 승인을 수행할 수 있습니다.

특정 서브스크립션을 서비스에 검색하거나 "종료"(승인용) 상태에 있는 모든 서브스크립션을 필터링하려면ECDHE > Accounts > Subscriptions로 이동합니다.

서브스크립션을 보려면 FlexVolume > 계정 > 사용 규칙에서 서비스 계획을 활성화합니다.

한 번에 하나의 서브스크립션 또는 여러 개를 선택하고 대규모 승인을 수행할 수 있습니다.

애플리케이션을 검색하거나 "종료"(승인용) 상태에 있는 모든 애플리케이션을 필터링하려면 다음을 수행합니다.

한 번에 하나의 애플리케이션 또는 여러 애플리케이션을 선택하고 대규모 승인을 수행할 수 있습니다.

개발자 계정의 세부 정보 페이지에서 시작하여 승인하려는 애플리케이션을 선택한 다음 애플리케이션 세부 정보 페이지에서 승인할 수도 있습니다.

특정 계정을 검색하거나 필터링하려면 DestinationRule &gt ; 계정 > 목록으로 이동합니다.

한 번에 하나 이상의 행을 선택하고 계획을 변경할 수 있습니다.

특정 서브스크립션을 서비스에 검색하거나 필터링하려면ECDHE > 계정 > 서브스크립션으로 이동합니다.

설정 페이지에서 서비스 계획을 활성화한 경우에만 서브스크립션을 볼 수 있습니다.

한 번에 하나 또는 여러 서브스크립션을 선택하고 계획을 변경할 수 있습니다.

특정 애플리케이션을 검색하거나 필터링하려면 DestinationRule &gt ; 애플리케이션 > 목록으로 이동합니다.

한 번에 하나 또는 여러 애플리케이션을 선택하고 계획을 변경할 수 있습니다.

또 다른 시나리오는 개발자 계정의 세부 정보 페이지에서 시작하는 것입니다. 여기에서 계획을 변경할 애플리케이션을 선택합니다. 애플리케이션 세부 정보 페이지에서 계획을 변경할 수 있습니다.

해당 애플리케이션을 관리하는 계정과 개발자가 이미 알고 있는 경우 아래와 같이ECDHE > 계정 > 계정 > 목록의 계정 페이지에서 해당 계정으로 이동합니다.

애플리케이션 ID 또는 API 키만 있는 경우ECDHE > 계정 > 목록 의 계정 페이지에서 검색 상자를 사용하여 관련 계정을 찾을 수 있습니다. 애플리케이션 검색에 대한 자세한 내용은 여기에서 확인할 수 있습니다.

아래와 같이 계정 프로필 페이지에 있으면 메시지 아이콘을 클릭합니다.

여기에서 생성된 메시지는 계정 시스템 대시보드로 모두 전송됩니다. 여기서 계정의 모든 개발자가 해당 내용을 볼 수 있으며, 해당 계정 내에 admin 상태가 있는 개발자 계정의 사용자에게 이메일로 전송됩니다.

긴급 상황이며 이메일이 귀하의 목적에 맞게 충분히 빠르지 않을 경우 가입시 개발자가 제출한 연락처 정보를 사용할 수도 있습니다.

등록시 전화 번호를 필수 필드로 만들 수 있습니다.

관심 있는 개발자 계정의 세부 정보 페이지를 보려면 다음을 수행합니다.

사용자 지정할 계획이 있는 애플리케이션을 선택합니다.

옵션을 "customize"로 선택합니다. 이렇게 하면 이 계정이 소유한 애플리케이션에 대해 모든 계획 요소를 사용자 지정할 수 있는 페이지가 제공됩니다.

애플리케이션을 찾으려면 해당 애플리케이션이 속한 계정의 이름 또는 애플리케이션 이름이 필요합니다. 이 정보가 없는 경우 액세스 로그를 확인할 수 있습니다. 검색을 수행하려면 애플리케이션(ECDHE > 애플리케이션> 목록)으로 이동합니다.

식별자로 인증 유형을 검색하는 경우 다음 정보가 필요합니다.

지정된 애플리케이션을 검색하려면 애플리케이션 페이지(ECDHE >Applications > listing)로 이동하여 아래 이미지에 표시된 대로 검색 상자를 사용합니다.

결과가 반환되면 액세스하려는 애플리케이션을 클릭합니다. 그러면 아래 이미지에 표시된 것과 같은 정보가 포함된 애플리케이션의 홈페이지로 이동합니다.

관리 포털을 통해 서브스크립션하는 서비스에서 단일 개발자 구독 취소:

더 이상 사용되지 않거나 삭제된 서비스에서 여러 개발자를 취소하려면 대규모 작업을 수행합니다.

서비스 계획을 활성화해야 합니다.

계정 또는 애플리케이션 탭에서 또는 여기에 설명된 대로 검색하여 애플리케이션을 찾을 수 있습니다.

애플리케이션을 찾아서 애플리케이션 요약 페이지를 보려면 'State' 값 옆에 있는 일시 중지 아이콘을 클릭합니다. 이 작업은 API에서 애플리케이션을 즉시 비활성화하고 모든 키가 작동하지 않도록 일시 중지합니다. 이러한 애플리케이션 키를 사용한 호출은 제어 시스템에서 거부됩니다.

문제가 있는 동작이 수정되면 동일한 버튼을 사용하여 애플리케이션을 일시 정지할 수 있습니다.

애플리케이션 개발자에게 문의하는 방법은 워크플로우 및 정책에 따라 다릅니다. 동일한 페이지에서 계정 이름을 클릭하면 애플리케이션을 소유한 계정의 키 관리자를 식별할 수 있는 계정 보기로 이동할 수 있습니다. 표시된 대로 이메일 또는 전송 메시지 버튼을 클릭하여 사용자에게 대시보드 메시지를 생성할 수 있습니다.

이 가이드를 사용하기 전에 시작하기 섹션의 지침을 완료하십시오.

이 가이드에서는 기존 3scale 코드 플러그인 중 하나를 사용하여 통합을 수행한다고 가정합니다. 다른 통합 방법을 사용하여 유사한 흐름을 따를 수 있습니다. 사용 가능한 통합 옵션에 대한 자세한 내용은 설명서의 운영 APIcast 장을 확인하십시오.

3scale은 API 제품 통계에 대해 무한하게 확장 가능한 데이터 리포지터리 역할을 하며 API 제품에 대한 거의 모든 메트릭을 추적할 수 있습니다. 예를 들어 다음과 같습니다.

API 제품과 관련된 더 많은 메트릭을 추적할 수 있습니다. 3scale은 시간 경과에 따라 증가될 수 있는 수량에 따라 임의의 수의 메트릭과 방법을 추적할 수 있습니다.

지표를 선택한 후 관리 포털에서 등록합니다. [gradle_product_name] > 통합 > 방법 및 지표 로 이동합니다.

API에 메트릭 및 메서드를 추가할 수 있습니다. Friendly 이름과 시스템 이름을 지정합니다. 이 이름은 플러그인 구성에서 나중에 사용됩니다. 메서드 및 지표 생성에 대한 자세한 내용은 3scale에서 API 정의를 참조하십시오.

3scale 시스템을 추적 지표의 이름으로 구성하면 플러그인 설정에서 올바른 메트릭을 보고해야 합니다. 이 작업을 수행하는 정확한 방법은 사용 중인 플러그인 또는 통합 방법에 따라 다릅니다. 기본적으로 플러그인은 적중 (API 트랜잭션) 메트릭만 보고합니다.

일반적으로 이러한 단계를 수행해야합니다.

특정 API 메서드의 트래픽을 보고할 때 지표 인수에서 메서드 시스템 이름을 사용합니다. 이렇게 하면 보고된 방법과 적중 지표에 대한 카운터가 자동으로 증가합니다.

API 및 3scale 연결이 설정되면 API로 트래픽을 보내고 API NSX 대시보드에 등록할 수 있습니다. 이 섹션의 단계를 수행하려면 기존 개발자 계정과 API 인증 정보가 포함된 애플리케이션이 필요합니다. 다음 단계에 따라 개발자 계정을 생성하고 API 자격 증명을 사용하여 애플리케이션을 가져옵니다.

NSX 섹션의 사용량 차트에 트래픽이 표시되지 않는 경우 다음 검사를 수행합니다.

기본적으로 사용량 통계는 관리 포털과 개발자 포털을 통해 애플리케이션을 생성한 개발자에게 API 공급자에 표시됩니다. (각 개발자는 자체 애플리케이션에 대한 사용량 통계만 볼 수 있습니다.) 개발자 포털에서 분석 보기를 숨길 수 있습니다. 개발자 포털 사용자 지정에 대한 자세한 내용은 개발자 포털 생성 섹션을 참조하십시오.

DestinationRule 섹션의 사용 그래프 외에도 API 제품의 분석 데이터를 가져오는 다른 방법이 있습니다.

3scale은 API 대시보드에서 사용 가능한 기능을 지속적으로 개선합니다. 그러나 개발 계획보다 앞서 있을 수 있으며 아직 지원되지 않는 특정 요구 사항이 있을 수 있습니다.

API 관리 요구를 충족하기 위해 3scale은 항상 모든 데이터에 액세스할 수 있는 도구를 제공합니다. 그러나 사용자 지정 스크립트에는 약간의 비용이 듭니다. 스크립트를 작성하는 데 일부 리소스가 필요하지만 이 문서에 나와 있는 것처럼 비용이 너무 높지 않습니다. 더 중요한 것은ECDHE를 통해 생각할 수 있는 모든 사용 사례를 구현할 수 있는 완전한 유연성과 제어 기능을 제공합니다.

최근 고객은 3scale로 간소화된 방식으로 해결할 수 없는 매우 구체적인 요구 사항을 제시했습니다.

주당 수천 명의 새로운 개발자를 확보했습니다. 3scale API Management Platform으로 인해 이러한 성공을 유지할 수 있었습니다. 온보딩을 사용하면 개발자가 어려운 작업이 될 수 있습니다. 3scale은 주요 프로비저닝, 가입 워크플로 및 이메일 통신과 같은 필수 사항을 자동화할 수 있습니다. 지금까지는 매우 좋습니다.

그러나 3scale과 함께 할 수 없는 일이 있었습니다. 이는 매우 중요했습니다. 많은 사람이 온보딩하고 있기 때문에 API와의 참여를 기반으로 새 개발자를 분류하여 운영 및 마케팅팀이 새로운 개발자와 보다 효과적으로 상호 작용할 수 있는 간단한 방법이 필요했습니다.

이러한 기능은 적어도 필요한 수준의 세부 사항은 3scale 내장 분석 도구에서 아직 사용할 수 없습니다. 그러나 모든 데이터를 이미 사용할 수 있으므로 3scale 계정 및 analytics API를 사용하여 추출할 수 있습니다.

지난 10 일 동안 무료 평가 계획에 가입 한 새로운 개발자가 얼마나 많은 다른 방법으로 가입했는지 알고 싶습니다.

먼저, 얼마나 많은 개발자가 가입했는지 알고 싶었지만 API를 사용하지 않았습니다. 이 정보로 하고 싶었던 내용은 이 문서에서 다루지 않지만 API 채택에 도움이 될 중요한 정보입니다.

두 번째, API를 사용한 개발자를 두 그룹으로 나누고자 했습니다.

이 정보는 3scale 기본 제공 분석에서 확인할 수 있습니다. 문제는 집계된 것으로 표시할 수 있는 보기가 없기 때문에 전체 환경이 매우 번거롭다는 것입니다.

이 문제에 대한 일반적인 해결책은 이러한 분류가 향후 분석 개선의 일부가 될 것입니다. 그러나 지금 필요한 경우 문제를 해결하지 못합니다. 3scale에서는 릴리스 일정에 따라 필요한 모든 작업을 수행할 수 있는 도구를 제공합니다.

3scale은 매우 편리합니다. 누구나 계약한 모든 서비스의 현재 기능을 확장할 수 있어야 합니다. 모든 기지를 커버 할 수 있다고 생각하는 것처럼, 우리는 매우 특별한 필요이거나 다른 기능을 구축하고 있기 때문에 특정 측면에서 항상 뒤처질 것입니다. 어떤 일이 있어도 즉시 가능하지 않을 때 차단되는 것을 피하고 싶습니다. 데이터에 대한 모든 액세스 권한과 완전한 API 툴셋을 제공하여 작업할 수 있습니다.

If you have scripts that you want to share with us and the rest of 3scale users, please send them. 저희는 이를 수집하고 공개해 주셔서 감사합니다.