Jump To Close Expand all Collapse all Table of contents Admin Portal Guide Preface Making open source more inclusive I. Account settings Expand section "I. Account settings" Collapse section "I. Account settings" 1. Account configuration Expand section "1. Account configuration" Collapse section "1. Account configuration" 1.1. Add your company information 1.2. Select your preferred time zone 2. Red Hat Single Sign On for the 3scale Admin Portal Expand section "2. Red Hat Single Sign On for the 3scale Admin Portal" Collapse section "2. Red Hat Single Sign On for the 3scale Admin Portal" 2.1. Enable RH-SSO or Auth0 member authentication Expand section "2.1. Enable RH-SSO or Auth0 member authentication" Collapse section "2.1. Enable RH-SSO or Auth0 member authentication" 2.1.1. RH SSO prerequisites 2.1.2. Auth0 prerequisites 2.1.3. Enable RH-SSO 2.2. Using RH-SSO with 3scale 2.3. Redirecting a 3scale login to a RH-SSO option Expand section "2.3. Redirecting a 3scale login to a RH-SSO option" Collapse section "2.3. Redirecting a 3scale login to a RH-SSO option" 2.3.1. Prerequisites 2.3.2. Required steps 3. Inviting users and managing rights Expand section "3. Inviting users and managing rights" Collapse section "3. Inviting users and managing rights" 3.1. Navigate to user administration 3.2. Send an invitation 3.3. Accept the invitation 3.4. Give new users rights 4. Notifications Expand section "4. Notifications" Collapse section "4. Notifications" 4.1. Types of notifications 4.2. Visibility 4.3. Subscribing to notifications by email 4.4. Web notifications 5. Personal settings 6. Tokens Expand section "6. Tokens" Collapse section "6. Tokens" 6.1. Access tokens 6.2. Creating access tokens 6.3. Using access tokens Expand section "6.3. Using access tokens" Collapse section "6.3. Using access tokens" 6.3.1. Service tokens II. Managing developer accounts Expand section "II. Managing developer accounts" Collapse section "II. Managing developer accounts" 7. Adding developers Expand section "7. Adding developers" Collapse section "7. Adding developers" 7.1. Create a new developer account 7.2. Set up applications 7.3. Notify the developer 8. Approving developers Expand section "8. Approving developers" Collapse section "8. Approving developers" 8.1. Approve from email notification 8.2. Account approval 8.3. Service approval 8.4. Application approval 9. Changing plans for an app Expand section "9. Changing plans for an app" Collapse section "9. Changing plans for an app" 9.1. Change account plans 9.2. Change service plans 9.3. Change application plans Expand section "9.3. Change application plans" Collapse section "9.3. Change application plans" 9.3.1. More information 10. Contacting developers Expand section "10. Contacting developers" Collapse section "10. Contacting developers" 10.1. Locate the relevant application and account in the system 10.2. Send internal messages to developers 10.3. Contact by other means 11. Customize plans Expand section "11. Customize plans" Collapse section "11. Customize plans" 11.1. Choose the account 11.2. Select the application 11.3. Customize the application plan Expand section "11.3. Customize the application plan" Collapse section "11.3. Customize the application plan" 11.3.1. More information 12. Enable signup 13. Finding applications Expand section "13. Finding applications" Collapse section "13. Finding applications" 13.1. Get the information you need 13.2. Search for the application 13.3. Access application information 14. Inviting developers 15. Unsubscribing developers from a service Expand section "15. Unsubscribing developers from a service" Collapse section "15. Unsubscribing developers from a service" 15.1. Unsubscribing a single developer from services 15.2. Unsubscribing multiple developers from services 16. Suspending applications Expand section "16. Suspending applications" Collapse section "16. Suspending applications" 16.1. Find the application 16.2. Disable the application 16.3. Contact the developer 17. Deleting applications 18. Deleting an API III. Access control Expand section "III. Access control" Collapse section "III. Access control" 19. Designating methods and adding metrics for capturing usage details Expand section "19. Designating methods and adding metrics for capturing usage details" Collapse section "19. Designating methods and adding metrics for capturing usage details" 19.1. Adding methods to products and backends 19.2. Adding metrics to products and backends 19.3. Alternatives for importing methods and metrics 19.4. Adding mapping rules to methods and metrics 19.5. Additional resources 20. Application plans Expand section "20. Application plans" Collapse section "20. Application plans" 20.1. How to create an application plan 20.2. Setting up a default application plan 21. Provisioning paid plans Expand section "21. Provisioning paid plans" Collapse section "21. Provisioning paid plans" 21.1. Deciding your pricing model 21.2. Configuring an application plan with your pricing rules 21.3. Creating further pricing tiers 21.4. Provisioning the paid plans 21.5. Additional references 22. Provisioning rate limits Expand section "22. Provisioning rate limits" Collapse section "22. Provisioning rate limits" 22.1. Configuring the application plan 22.2. Setting the rate limits 22.3. Putting the new rate limits into action 22.4. More information IV. Billing Expand section "IV. Billing" Collapse section "IV. Billing" 23. Configuring Billing Settings Expand section "23. Configuring Billing Settings" Collapse section "23. Configuring Billing Settings" 23.1. Billing modes (Charging & Gateway) 23.2. Charging enabled (Charging & Gateway) 23.3. Currency (Charging & Gateway) 23.4. Invoice footnote (Charging & Gateway) 23.5. Text to show if VAT/Sales Tax is 0% (Charging & Gateway) 23.6. YAML configuration for currencies Expand section "23.6. YAML configuration for currencies" Collapse section "23.6. YAML configuration for currencies" 23.6.1. Changing the currencies configuration in OpenShift 23.6.2. Verifying the new currencies 23.7. Billing periods for invoice ids (Charging & Gateway) 23.8. Credit Card Policies 24. Credit card gateways for payments Expand section "24. Credit card gateways for payments" Collapse section "24. Credit card gateways for payments" 24.1. Credit card gateways supported by 3scale 24.2. Configuring Stripe as a credit card gateway Expand section "24.2. Configuring Stripe as a credit card gateway" Collapse section "24.2. Configuring Stripe as a credit card gateway" 24.2.1. Generating an access token with the Billing API scope in the 3scale Admin Portal 24.2.2. Obtaining the keys and the webhook secret from Stripe 24.2.3. Configuring charging in the 3scale Admin Portal 24.2.4. Editing credit card details in the 3scale Developer Portal 24.2.5. Updating the text of unsuccessfully charged email response 24.3. Configuring Braintree as a credit card gateway 24.4. Allowing payments of rejected invoices via the Developer Portal 24.5. Troubleshooting issues with credit card gateways 25. Pricing Expand section "25. Pricing" Collapse section "25. Pricing" 25.1. Pricing rules 25.2. Setting pricing rules 25.3. Update existing pricing rules 26. Billing Expand section "26. Billing" Collapse section "26. Billing" 26.1. Listing invoices 26.2. Invoice view Expand section "26.2. Invoice view" Collapse section "26.2. Invoice view" 26.2.1. Invoice details 26.2.2. Editing invoices 26.3. Invoice states 26.4. Automated billing process Expand section "26.4. Automated billing process" Collapse section "26.4. Automated billing process" 26.4.1. On the first day of each month 26.4.2. Every day 26.4.3. Automatic and manual invoices 26.4.4. Mid-month upgrades Expand section "26.4.4. Mid-month upgrades" Collapse section "26.4.4. Mid-month upgrades" 26.4.4.1. Prepaid billing 26.4.4.2. Postpaid billing 26.5. Enable/disable billing/charging per account 26.6. Plans with a trial period 26.7. VAT rate/Sales Tax Expand section "26.7. VAT rate/Sales Tax" Collapse section "26.7. VAT rate/Sales Tax" 26.7.1. Configure VAT rate field 26.7.2. Configure VAT code field 26.7.3. Set VAT values for an account 26.7.4. Invoices with VAT 26.8. Developer Portal view 26.9. Credit card flow Expand section "26.9. Credit card flow" Collapse section "26.9. Credit card flow" 26.9.1. Sign up for a paid plan 26.9.2. Upgrade from a free to a paid plan 26.10. "Billing address" field 27. Email Notifications Expand section "27. Email Notifications" Collapse section "27. Email Notifications" 27.1. Provider notifications 27.2. Developer emails Expand section "27.2. Developer emails" Collapse section "27.2. Developer emails" 27.2.1. Billing email address 28. Billing API V. Service Discovery: from OpenShift to 3scale Expand section "V. Service Discovery: from OpenShift to 3scale" Collapse section "V. Service Discovery: from OpenShift to 3scale" 29. Service Discovery Expand section "29. Service Discovery" Collapse section "29. Service Discovery" 29.1. About Service Discovery 29.2. Criteria for a discoverable service 29.3. Considerations for configuring OpenShift to enable Service Discovery 29.4. Configuring Service Discovery with an OpenShift OAuth server 29.5. Configuring Service Discovery with an RH-SSO server (Keycloak) 29.6. Configuring Service Discovery without an OAuth server 29.7. Importing discovered services 29.8. Authorizing 3scale access to an OpenShift project 29.9. Updating services VI. Multitenancy Expand section "VI. Multitenancy" Collapse section "VI. Multitenancy" 30. Multitenancy Expand section "30. Multitenancy" Collapse section "30. Multitenancy" 30.1. Master Admin Portal Expand section "30.1. Master Admin Portal" Collapse section "30.1. Master Admin Portal" 30.1.1. Accessing the Master Admin Portal 30.1.2. Adding an account through the Master Admin Portal 30.1.3. Creating a single gateway with the Master Admin Portal 30.2. Managing accounts Expand section "30.2. Managing accounts" Collapse section "30.2. Managing accounts" 30.2.1. Managing accounts through the Master Admin Portal 30.2.2. Managing accounts through API calls 30.3. Understanding multitenancy subdomains 30.4. Deleting tenant accounts Expand section "30.4. Deleting tenant accounts" Collapse section "30.4. Deleting tenant accounts" 30.4.1. Deleting an account via the Admin Portal 30.4.2. Deleting a tenant via the console 30.5. Resuming tenant accounts VII. Analytics Expand section "VII. Analytics" Collapse section "VII. Analytics" 31. Implementing 3scale API analytics to manage and optimize API access Expand section "31. Implementing 3scale API analytics to manage and optimize API access" Collapse section "31. Implementing 3scale API analytics to manage and optimize API access" 31.1. 3scale API metrics and methods that capture API use 31.2. Configuring 3scale plugins to capture API metrics 31.3. Viewing analytics for 3scale API backends 31.4. Sending test requests to confirm plugin configuration for capturing API metrics 31.5. Troubleshooting techniques when analytics are missing for 3scale APIs 32. Exporting 3scale API analytics beyond built-in capabilities Expand section "32. Exporting 3scale API analytics beyond built-in capabilities" Collapse section "32. Exporting 3scale API analytics beyond built-in capabilities" 32.1. Example of using 3scale to extract data about application use 32.2. Extracting 3scale application analytics in custom procedures 33. Viewing 3scale built-in traffic analytics for applications 34. Setting up and evaluating the 3scale response codes log for your API Legal Notice Settings Close Language: 日本語 简体中文 한국어 English Language: 日本語 简体中文 한국어 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 日本語 简体中文 한국어 English Language: 日本語 简体中文 한국어 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Part IV. Billing Previous Next
