관리자 포털 가이드

1. 상단 탐색 표시줄 오른쪽에 있는 톱니바 아이콘을 클릭합니다. 개요 창이 표시됩니다.
2. 계정 세부 정보 제목 옆에 있는 편집 링크를 클릭합니다.
3. 계정에 대한 정보를 입력합니다.

1. 3scale 로그인 페이지로 이동합니다.

   https://<organization>-admin.3scale.net/p/login

   Copy to Clipboard Toggle word wrap
2. IdP로 3scale 승인
3. 필요한 경우 필요한 정보를 입력하여 완전히 등록하십시오.

1. 탐색 모음에서 창의 오른쪽 상단에 있는 톱니바 아이콘을 클릭합니다.
2. 왼쪽 메뉴에서 사용자 & gt; 목록으로 이동합니다.

1. 목록 위의 오른쪽 상단에 있는 초대 사용자 링크를 클릭합니다.
2. 초대하려는 사람의 이메일 주소를 입력하고 보내기 를 클릭합니다.
3. 전송 확인으로 창의 오른쪽 상단에 메시지가 표시됩니다. 초대가 성공적으로 전송되었습니다.

1. 계정 설정(게이션 표시줄의 아이콘) > 개인 > 알림 기본 설정으로 이동합니다.
2. 수신하려는 알림을 선택합니다.
3. 알림 기본 설정 업데이트를 클릭합니다.

1. 네비게이션 바에서 톱니바를 클릭합니다.
2. Personal > Tokens 로 이동합니다.
3. 액세스 토큰 추가를 클릭합니다.
4. 이름을 지정하고, 하나 이상의 범위를 선택한 다음 토큰에 대한 권한을 선택합니다.
5. 새 토큰을 저장하려면 액세스 토큰 생성을 클릭합니다.

1. 관리 포털의 Gradle 섹션에서 계정 링크를 따릅니다.
2. 생성을 클릭합니다.

1. NodeNetwork &gt ; Applications > Listing ... 로 이동합니다.
2. 드롭다운 목록에서 "pending"을 선택하고 Search 를 클릭합니다.

1. NodeNetwork &gt ; Accounts > Listing으로이동합니다.
2. 개발자 계정 선택

1. 관리 포털의 대시보드에서 NetNamespace > Accounts > Listing > [select an account] > Service Subscriptions 으로 이동합니다.
2. 개발자를 제거할 서비스에 대해 Unsubscribe 를 선택합니다.

1. 대시보드에서: NetNamespace &gt ; Accounts > Subscriptions.
2. 대량 상태 변경을 수행합니다.
3. 서비스 드롭다운 메뉴를 사용하여 개발자의 구독을 취소할 서비스를 식별합니다.
4. 왼쪽의 확인란을 사용하여 구독 취소하려는 개발자를 선택합니다.
5. Change State > Suspend 를 선택하여 선택한 개발자 서브스크립션을 일시 중지합니다.

절차

1. [your_product_name] > Integration > Methods & Metrics 또는 [your_backend_name] > Methods & Metrics 로 이동합니다.
2. Add a method 를 클릭합니다.

3. Friendly name 필드에 메서드에 대한 간단한 설명을 입력합니다. 이 이름은 3scale 관리 포털의 다른 섹션에 표시됩니다. 친숙한 이름은 제품에 대해 고유해야 합니다.

   중요

   메서드의 시스템 이름을 변경하거나 삭제하는 데 주의하십시오. 이러한 변경 사항은 메서드의 이전 시스템 이름을 가리키는 매핑 규칙이 있는 경우 이미 배포된 3scale 통합을 중단할 수 있습니다.

4. 시스템 이름 필드에 3scale Service Management API를 통해 사용량을 보고하는 데 사용할 API의 메서드 이름을 입력합니다.

   시스템 이름의 형식을 결정합니다. 이 이름은 끝점(/status)과 유사하거나, 예를 들어 메서드 및 경로(GET_/status)를 포함할 수 있습니다. 그러나 시스템 이름은 이러한 규칙을 준수해야 합니다.

   • 제품 또는 백엔드에서 고유
   • 영숫자만 포함 _, 하이픈 - 또는 슬래시 /
   • 공백 없음
   • 백엔드 API의 경우 메서드의 시스템 이름에 매핑되는 백엔드를 식별하는 숫자 문자열이 포함됩니다. 이 백엔드 식별자는 수정할 수 없습니다.
5. 선택 사항: 설명 필드에 메서드에 대한 자세한 설명을 입력합니다.
6. Create Method (메서드 생성)를 클릭합니다.

절차

1. [your_product_name] > Integration > Methods & Metrics 또는 [your_backend_name] > Methods & Metrics 로 이동합니다.
2. Metrics 탭을 클릭합니다.
3. 지표 추가를 클릭합니다.

4. Friendly name 필드에 지표에 대한 간단한 설명을 입력합니다. 이 이름은 3scale 관리 포털의 다른 섹션에 표시됩니다. 친숙한 이름은 제품에 대해 고유해야 합니다.

   중요

   지표의 시스템 이름을 변경하거나 삭제하는 데 주의하십시오. 이러한 변경 사항으로 인해 이전 지표 시스템 이름을 가리키는 매핑 규칙이 있는 경우 이미 배포된 3scale 통합이 중단될 수 있습니다.

5. System name 필드에 3scale Service Management API를 통해 사용량을 보고하는 데 사용할 API의 지표 이름을 입력합니다.

   시스템 이름의 형식을 결정합니다. 그러나 시스템 이름은 이러한 규칙을 준수해야 합니다.

   • 제품 또는 백엔드에서 고유
   • 영숫자만 포함 _, 하이픈 - 또는 슬래시 /
   • 공백 없음
   • 백엔드 API의 경우 지표의 시스템 이름에 매핑되는 백엔드를 식별하는 숫자 문자열이 포함되어 있습니다. 이 백엔드 식별자는 수정할 수 없습니다.

6. 단위 필드에 단위를 입력합니다.

   • 예를 들어 단수형 이름(예: )을 사용합니다. 분석 차트에서는 단수형이 될 것입니다.
7. 선택 사항: 설명 필드에 지표에 대한 자세한 설명을 입력합니다.
8. Create Metric 을 클릭합니다.

절차

1. [your_product_name] > Integration > Mapping Rules 로 이동합니다.
2. 매핑 규칙 만들기를 클릭합니다.
3. Verb 필드는 HTTP 메서드로 미리 채워져 있지만 드롭다운 목록에서 다른 옵션을 선택할 수 있습니다.
4. Pattern 필드에 슬래시 / 로 시작하는 유효한 URL을 추가합니다. URL은 curly brackets {} 내에서 지정한 와일드카드에서 사용할 수 있습니다.
5. Metric or method to increment field, 이전에 생성한 메서드 또는 메트릭 중 하나를 선택합니다.
6. 필드를 기준으로 하는 필드는 1 로 미리 채워져 있지만, 이를 자체 요구 사항에 맞게 변경합니다.
7. 매핑 규칙 생성 버튼을 클릭합니다.

1. [ your_product_name] > Applications > Application Plans 로 이동합니다.
2. Create Application Plan 버튼을 클릭합니다.
3. Create Application Plan (애플리케이션 계획 생성) 페이지에서 새 계획에 대해 이름 및 시스템 이름(시스템 이름을 고유해야 함)을 입력합니다.
4. API에 액세스하기 전에 애플리케이션에 승인해야 하는 경우 승인이 필요한 애플리케이션을 선택합니다.

1. [ your_product_name] > Applications > Application Plans 로 이동합니다.
2. 기본 계획 아래의 드롭다운 목록에서 계획을 선택합니다.

1. [your_product_name] > 개요 > Applications > Application Plans로 이동합니다.
2. 애플리케이션 계획 이름을 클릭합니다.
3. 지표, 방법, 제한 및 가격 규칙으로 이동합니다. 여기서는 총 히트 수준, 메서드 단위 또는 사용자 지정 메트릭 수준에서 가격을 정의할 수 있습니다.

1. [your_product_name] > 개요 > 애플리케이션 > 애플리케이션 계획으로 이동합니다.
2. 구성할 애플리케이션 계획의 이름을 클릭합니다.
3. 지표, 메서드, 제한, 가격 규칙 까지 아래로 스크롤합니다.
4. 제한을 클릭합니다.
5. 제품 또는 백엔드 수준에 대한 제한을 구성합니다.
6. 필요한 제한 설정을 완료하면 애플리케이션 계획 업데이트를 클릭하여 변경 사항을 저장합니다.

1. 3scale 관리자 포털의 gettinging API 범위를 사용하여 액세스 토큰을 생성합니다.
2. Stripe에서 키와 Webhook 시크릿을 가져옵니다.
3. 3scale 관리 포털에서 배당 구성.
4. 3scale 개발자 포털에서 스코어 카드 세부 정보 편집
5. 실패한 이메일 응답을 업데이트하지 못했습니다.

1. Braintree에서 키 및 서명자 식별자 가져오기.
2. 3scale 관리 포털에서 과금 구성.
3. 3scale 개발자 포털에서 신용 카드 세부 정보 편집

1. Gradle &gt ; 청구 > 청구 > 게이트웨이 로 이동합니다.
2. Addging enabled를 선택합니다.

3. 통화를 선택합니다.

   • 3scale billing 페이지에서 지정한 통화 유형은 Braintree Vendor 계정에서 사용되는 통화 유형과 일치해야 합니다.
4. 저장을 클릭합니다.
5. credit card gateway > Gateway 에서 게이트웨이로 Braintree 를 선택합니다.
6. Braintree에서 키 및 서명자 식별자 가져오기 Braintree 계정에서 얻은 공개 키, Merchant ID 및 개인 키를 추가합니다.
7. 3DS를 활성화하려면 3D Secure Enabled 를 선택합니다.
8. 변경 사항 저장을 클릭합니다.

1. 개발자 계정으로 3scale 개발자 포털에 로그인합니다.
2. Settings > credit Card Details 로 들어가세요.
3. Add credit Card Details and billing Address 링크를 클릭합니다.
4. 결제 세부 정보 추가: 이름, 성, 전화.
5. 신용 카드 번호, 만기 날짜 및 CVC를 추가합니다.
6. 회사, 거리 주소, 우편 번호, 도시, 주/지역 등 청구 주소 세부 정보를 추가합니다. 그런 다음 국가를 선택하십시오.
7. Save details 를 클릭합니다.
8. 메시지가 표시되면 구매에 대한 2 단계 인증 (2FA)을 완료합니다. 예를 들어, 은행이 SMS 2FA 옵션을 설정한 경우 이 방법을 사용하여 인증 프로세스를 완료해야 합니다.

1. 3scale 관리 포털에서 NetNamespace &gt ; 개발자 포털 > 콘텐츠로 이동합니다.
2. Root > Invoices > Show template.

3. 다음 코드 행을 변경합니다.

   <a href="{{ urls.invoices }}">
     <i class="fa fa-chevron-left"></i>
       Cancel
       </a>
       {{ invoice.period_begin | date: '%B, %Y' }} Invoice

   Copy to Clipboard Toggle word wrap

   이 스니펫에서는:

   <div class="clearfix">
     <a href="{{ urls.invoices }}">
       <i class="fa fa-chevron-left"></i>
         Cancel
       </a>
       {{ invoice.period_begin | date: '%B, %Y' }} Invoice
       {% if invoice.pay_now? %}
         <a href="{{invoice.url}}/payment" class="pull-right btn btn-success pay-invoice-btn">Pay invoice</a>
       {% endif %}
   </div>

   Copy to Clipboard Toggle word wrap

1. [your_API_service] > Applications > Application Plans 로 이동합니다.
2. 기존 애플리케이션 계획을 선택하거나 새 애플리케이션을 생성합니다.
3. 지표, 방법, 제한 및 가격 규칙에서 가격 책정 (x) 을 클릭하여 가격 섹션을 엽니다.
4. 새 가격 규칙을 클릭합니다.
5. 단위당 값, 대상 및 비용 값을 설정하고 가격 규칙 만들기를 클릭합니다.

1. 편집을 클릭합니다.
2. From, To 및 Cost(단일 대상, 비용) 필드에 필요한 조정을 수행합니다.
3. 업데이트 가격 규칙을 클릭합니다.

1. Gradle &gt ; Accounts > Fields Definitions 로 이동합니다.
2. Account 블록 아래에 있는 Create 를 클릭합니다.
3. 드롭다운 목록에서 'billing_address'를 선택하고 레이블을 추가하고 Read only 확인란을 선택한 다음 생성을 클릭합니다.

절차

1. 3scale용 OpenShift OAuth 클라이언트를 생성합니다. 자세한 내용은 OpenShift 인증 설명서를 참조하십시오. 다음 예제에서는 < provide-a-client-secret >을 생성한 보안으로 바꾸고 < 3scale-master-domain-route >를 URL로 교체하여 3scale 마스터 관리 포털에 액세스합니다.

       $ oc project default
       $ cat <<-EOF | oc create -f -
       kind: OAuthClient
       apiVersion: v1
       metadata:
        name: 3scale
       secret: "<provide-a-client-secret>"
       redirectURIs:
        - "<3scale-master-domain-route>"
       grantMethod: prompt
       EOF

   Copy to Clipboard Toggle word wrap

2. 3scale Service Discovery 설정 파일을 엽니다.

       $ oc project <3scale-project>
       $ oc edit configmap system

   Copy to Clipboard Toggle word wrap

3. 다음 설정을 구성합니다.

       service_discovery.yml:
         production:
           enabled: true
           authentication_method: oauth
           oauth_server_type: builtin
           client_id: '3scale'
           client_secret: '<choose-a-client-secret>'

   Copy to Clipboard Toggle word wrap

4. 사용자가 검색 가능한 서비스가 포함된 클러스터 프로젝트를 볼 수 있는 적절한 권한이 있는지 확인합니다.

   관리자가 <user>로 표시하도록 하려면 검색할 서비스가 포함된 < namespace > 프로젝트의 보기 권한을 사용합니다.

   oc adm policy add-role-to-user view <user> -n <namespace>

   Copy to Clipboard Toggle word wrap

5. configmap 을 수정한 후에는 system-app 및 system-sidekiq Pod를 재배포하여 변경 사항을 적용해야 합니다.

   oc rollout latest dc/system-app
   oc rollout latest dc/system-sidekiq

   Copy to Clipboard Toggle word wrap

6. 롤아웃 상태를 확인하여 완료되었는지 확인합니다.

   oc rollout status dc/system-app
   oc rollout status dc/system-sidekiq

   Copy to Clipboard Toggle word wrap

절차

1. Red Hat OAuth 서버(Keycloak)에서 3scale용 OAuth 클라이언트를 만듭니다.

   참고

   클라이언트 구성에서 사용자 이름이 preferred_ username 에 매핑되어 OpenShift가 계정을 연결할 수 있는지 확인합니다.

2. 3scale Service Discovery 설정을 편집합니다.

       $ oc project <3scale-project>
       $ oc edit configmap system

   Copy to Clipboard Toggle word wrap

3. 다음 설정이 구성되어 있는지 확인합니다. 여기서 '<the-client-secret-from-Keycloak >은 OAuth 클라이언트를 생성할 때 Keycloak에서 자동으로 생성된 값입니다.

       service_discovery.yml:
         production:
           enabled: true
           authentication_method: oauth
           oauth_server_type: rh_sso
           client_id: '3scale'
           client_secret: '<the-client-secret-from-Keycloak>'

   Copy to Clipboard Toggle word wrap

4. 사용자가 검색 가능한 서비스가 포함된 클러스터 프로젝트를 볼 수 있는 적절한 권한이 있는지 확인합니다.

   예를 들어 &lt ;user& gt; 프로젝트에 대한 보기 권한을 부여 하려면 다음 명령을 사용하십시오.

   oc adm policy add-role-to-user view <user> -n <namespace>

   Copy to Clipboard Toggle word wrap
5. configmap 을 수정한 후에는 system-app 및 system-sidekiq Pod를 재배포하여 변경 사항을 적용해야 합니다.

절차

1. 3scale 프로젝트가 현재 프로젝트인지 확인합니다.

      $ oc project <3scale-project>

   Copy to Clipboard Toggle word wrap

2. 편집기에서 3scale Service Discovery 설정을 엽니다.

      $ oc edit configmap system

   Copy to Clipboard Toggle word wrap

3. 다음 설정이 구성되었는지 확인합니다.

   service_discovery.yml:
      production:
         enabled: <%= cluster_token_file_exists = File.exists?(cluster_token_file_path = '/var/run/secrets/kubernetes.io/serviceaccount/token') %>
         bearer_token: "<%= File.read(cluster_token_file_path) if cluster_token_file_exists %>"
         authentication_method: service_account

   Copy to Clipboard Toggle word wrap

4. 3scale 배포 amp 서비스 계정에 관련 권한을 제공하여 다음 옵션 중 하나에 따라 검색 가능한 서비스가 포함된 프로젝트를 확인합니다.

   • 클러스터 수준 보기 권한이 있는 3scale 배포 amp 서비스 계정에 부여합니다.

     oc adm policy add-cluster-role-to-user view system:serviceaccount:<3scale-project>:amp

     Copy to Clipboard Toggle word wrap
   • OpenShift - 서비스 계정에 설명된 대로 제한적인 정책을 적용합니다.

절차

1. 3scale 관리 포털에 로그인합니다.
2. 관리 포털 대시보드의 API 에서 생성을 클릭합니다.

3. OpenShift에서 가져오기 를 클릭합니다.

   • OAuth 토큰이 유효하지 않은 경우 OpenShift 프로젝트 관리자는 OpenShift 프로젝트에 대한 3scale 액세스 권한 부여에 설명된 대로 3scale 사용자에 대한 액세스 권한을 부여해야 합니다.
4. Namespace 필드에서 API가 포함된 OpenShift 프로젝트를 지정하거나 선택합니다(예: fuse ).
5. 이름 필드에 해당 네임스페이스 내에서 OpenShift 서비스의 이름을 입력하거나 선택합니다(예: i-task-api ).
6. 제품 생성을 클릭합니다.
7. 새 API 서비스를 3scale로 비동기적으로 가져올 때까지 기다립니다. 관리 포털의 오른쪽 상단에 메시지가 표시됩니다. 서비스는 곧 가져올 예정입니다. 완료되면 알림이 전송됩니다.

절차

1. Authenticate를 클릭하여 이 옵션 링크를 활성화합니다.
2. 네임스페이스 관리자 자격 증명을 사용하여 OpenShift에 로그인합니다.
3. 선택한 권한 허용을 클릭하여 3scale 사용자에 대한 액세스 권한을 부여합니다.

절차

1. 3scale 관리 포털에 로그인합니다.
2. API 제품의 개요 페이지로 이동합니다.
3. Source: OpenSource 옆의 새로 고침 링크를 클릭합니다.
4. 새 API 서비스를 3scale로 비동기적으로 가져올 때까지 기다립니다.

절차

1. 계정 목록을 보려면 Accounts 로 이동합니다.
2. 삭제할 계정을 클릭합니다.
3. 계정 세부 사항에서 Resume 를 클릭합니다.
4. 확인 을 클릭하여 계정을 다시 시작합니다.Click OK to confirm you want to resume the account.

절차

1. 들어오는 API 호출에 의해 결정된 대로 적절한 지표/메서드 이름을 플러그인에 전달합니다.

   필요한 지표/메서드 값 및 증가는 플러그인이 노출하는 승인 및/또는 보고서 메서드의 인수입니다.

2. 지표에서 System name 메서드를 사용하여 특정 API 메서드의 트래픽을 보고합니다.

   이렇게 하면 보고된 메서드 및 Hits 지표에 대한 카운터가 자동으로 증가합니다.

3. 관리 포털의 계정 설정 > 통합 → 3scale API Docs 에서 3scale 서비스 관리 API 를 사용하여 트래픽을 보고합니다.

절차

1. 관리 포털 대시보드에서 [your_backend_name] > analytics 로 이동합니다.
2. 보고서의 기간을 선택합니다. 지난 24시간, 7일, 30일, 12개월, 기간을 표시하도록 선택할 수 있습니다.

3. 선택 사항: Hits 이외의 분석 기능, 방법 또는 다른 최상위 메트릭을 선택합니다.

   • 차트에서 결과를 볼 수 있습니다. 보고할 트래픽이 없는 경우 다음 메시지가 표시됩니다. 선택한 기간에 사용 가능한 데이터가 없습니다.
4. CSV 다운로드 링크를 클릭하여 CSV 파일에서 데이터를 다운로드합니다.

절차

1. NodeNetwork & gt; Applications > Listing 으로 이동하여 기존 애플리케이션 목록을 확인합니다.
2. 이름을 클릭하여 애플리케이션을 선택합니다.

3. 선택한 애플리케이션의 API 자격 증명을 찾습니다. 인증 정보는 선택한 인증 유형에 따라 다르며 사용자 키(API 키), 애플리케이션 ID 및 애플리케이션 키 또는 클라이언트 ID와 클라이언트 시크릿이 될 수 있습니다.

   사용 가능한 인증 모드에 대한 자세한 내용은 인증 패턴을 참조하십시오.

   그림 31.1. API 인증 정보

   
4. 이러한 키를 사용하여 일반적인 방식으로 API를 호출합니다. 예를 들어, 명령 줄에서 cURL 을 사용하거나 API 엔드포인트의 경우 브라우저에서 GET 메서드를 사용합니다. 수행하는 정확한 호출은 API 제품의 방법에 따라 달라집니다. 이러한 호출의 트래픽은 API 제품의 분석 섹션에 나타납니다.

절차

1. 전체 애플리케이션 목록을 검색합니다. 이 작업을 수행하려면 페이지 지정이 필요합니다.

   def api_call_applications_list(domain, provider_key)
     done = false
     res = Array.new
     page = 1
   
         while !done
       url = "https://#{domain}/admin/api/applications.xml?provider_key=#{provider_key}&page=#{page}&per_page=100"
       page += 1
       response = RestClient.get url
       raise Exception.new("Wrong response code (#{response.code}) in request #{url}") if response.code!=200
       document = Nokogiri::XML(response.to_str)    done = document.xpath("applications/@current_page").text == document.xpath("applications/@total_pages").text
       document.xpath("//application").each do |item|
         app = Hash.new
         app["created_at"] = DateTime.parse(item.xpath("created_at").text)
         app["plan_name"] = item.xpath("plan/name").text
         app["service_id"] = item.xpath("plan/service_id").text
         app["account_id"] = item.xpath("user_account_id").text
         app["id"] = item.xpath("id").text
         res << app
       end
     end
     return res
   end

   Copy to Clipboard Toggle word wrap

2. 기준을 충족하지 않는 애플리케이션을 필터링하십시오. 즉 계획은 "검토"여야 하며 10일보다 최신 버전이어야 합니다.

   def filter_applications(domain, provider_key, plan_name, num_of_days)
     res = api_call_applications_list(domain, provider_key)
     res.each do |item|
       res.delete(item) if item["plan_name"] != plan_name
       res.delete(item) if item["created_at"] > (DateTime.now - num_of_days)
     end
     return res
   end

   Copy to Clipboard Toggle word wrap

3. 기준을 충족하는 각 애플리케이션에 대해 애플리케이션을 지난 10일 동안 애플리케이션의 히트 수에 해당하는 사용량을 가져옵니다.

   def api_call_application_usage(domain, provider_key, application_id, metric, from, to, granularity)
     url = "https://#{domain}/stats/applications/#{application_id}/usage.xml?provider_key=#{provider_key}&metric_name=#{metric}&since=#{from}&until=#{to}&granularity=#{granularity}"
     response = RestClient.get url
     raise Exception.new("Wrong response code (#{response.code}) in request #{url}") if response.code!=200
     document = Nokogiri::XML(response.to_str)
     return document.xpath("//usage/data/values").text.split(",")
   end

   Copy to Clipboard Toggle word wrap

4. 개발자의 정보가 계정 오브젝트에 저장되기 때문에 애플리케이션에 대한 교차 참조를 제공합니다.

   def api_call_account_read(domain, provider_key, account_id)
     url = "https://#{domain}/admin/api/accounts/#{account_id}.xml?provider_key=#{provider_key}"
     response = RestClient.get url
     raise Exception.new("Wrong response code (#{response.code}) in request #{url}") if response.code!=200
     document = Nokogiri::XML(response.to_str)
     account = Hash.new
     account["email"] = document.xpath("//users/user/email").text
     account["name"] = document.xpath("//users/user/first_name").text + " " + document.xpath("//users/user/last_name").text
     return account
   end

   Copy to Clipboard Toggle word wrap
5. 모든 것을 함께 넣어서 스크립트를 완료합니다. 3scale의 내장 분석에서 아직 제공되지 않은 정보를 가져오는 스크립트가 있습니다. 전체 스크립트를 gist로 가져올 수도 있습니다.