Jump To Close Expand all Collapse all Table of contents Admin Portal Guide Preface 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. Multitenancy Expand section "II. Multitenancy" Collapse section "II. Multitenancy" 7. Multitenancy Expand section "7. Multitenancy" Collapse section "7. Multitenancy" 7.1. Master Admin Portal Expand section "7.1. Master Admin Portal" Collapse section "7.1. Master Admin Portal" 7.1.1. Accessing the Master Admin Portal 7.1.2. Adding an account through the Master Admin Portal 7.1.3. Creating a single gateway with the Master Admin Portal 7.2. Managing accounts Expand section "7.2. Managing accounts" Collapse section "7.2. Managing accounts" 7.2.1. Managing accounts through the Master Admin Portal Expand section "7.2.1. Managing accounts through the Master Admin Portal" Collapse section "7.2.1. Managing accounts through the Master Admin Portal" 7.2.1.1. Additional information 7.2.2. Managing accounts through API calls 7.3. Understanding multitenancy subdomains 7.4. Deleting tenant accounts Expand section "7.4. Deleting tenant accounts" Collapse section "7.4. Deleting tenant accounts" 7.4.1. Deleting an account via the Admin Portal 7.4.2. Deleting a tenant via the console 7.5. Resuming tenant accounts III. Service discovery Expand section "III. Service discovery" Collapse section "III. Service discovery" 8. Service Discovery Expand section "8. Service Discovery" Collapse section "8. Service Discovery" 8.1. About Service Discovery Expand section "8.1. About Service Discovery" Collapse section "8.1. About Service Discovery" 8.1.1. Criteria for a discoverable service 8.2. Configuring Service Discovery Expand section "8.2. Configuring Service Discovery" Collapse section "8.2. Configuring Service Discovery" 8.2.1. Configuring with an OAuth server Expand section "8.2.1. Configuring with an OAuth server" Collapse section "8.2.1. Configuring with an OAuth server" 8.2.1.1. Using OpenShift OAuth server 8.2.1.2. Using RH-SSO server (Keycloak) 8.2.2. Configuring without an OAuth server 8.3. Discovering services 8.4. Authorizing 3scale access to an OpenShift project 8.5. Updating services IV. Access control Expand section "IV. Access control" Collapse section "IV. Access control" 9. Defining your API (Methods And Metrics) Expand section "9. Defining your API (Methods And Metrics)" Collapse section "9. Defining your API (Methods And Metrics)" 9.1. Adding methods and metrics 9.2. Importing your methods and metrics automatically 10. Application plans Expand section "10. Application plans" Collapse section "10. Application plans" 10.1. How to create an application plan 10.2. Setting up a default application plan 11. Mapping rules 12. Provisioning paid plans Expand section "12. Provisioning paid plans" Collapse section "12. Provisioning paid plans" 12.1. Deciding your pricing model 12.2. Configuring an application plan with your pricing rules 12.3. Creating further pricing tiers 12.4. Provisioning the paid plans 12.5. Additional references 13. Provisioning rate limits Expand section "13. Provisioning rate limits" Collapse section "13. Provisioning rate limits" 13.1. Configuring the application plan 13.2. Setting the rate limits 13.3. Putting the new rate limits into action 13.4. More information V. Billing Expand section "V. Billing" Collapse section "V. Billing" 14. Configuring Billing Settings Expand section "14. Configuring Billing Settings" Collapse section "14. Configuring Billing Settings" 14.1. Billing modes (Charging & Gateway) 14.2. Charging enabled (Charging & Gateway) 14.3. Currency (Charging & Gateway) 14.4. Invoice footnote (Charging & Gateway) 14.5. Text to show if VAT/Sales Tax is 0% (Charging & Gateway) 14.6. Billing periods for invoice ids (Charging & Gateway) 14.7. Credit Card Policies 14.8. Credit Card Gateways Expand section "14.8. Credit Card Gateways" Collapse section "14.8. Credit Card Gateways" 14.8.1. Stripe integration (recommended) Expand section "14.8.1. Stripe integration (recommended)" Collapse section "14.8.1. Stripe integration (recommended)" 14.8.1.1. Prerequisites 14.8.1.2. Getting your API keys from Stripe 14.8.1.3. Configuring settings in 3scale 14.8.2. Braintree integration Expand section "14.8.2. Braintree integration" Collapse section "14.8.2. Braintree integration" 14.8.2.1. Getting your API keys from Braintree 14.8.2.2. Configuring settings in 3scale Expand section "14.8.2.2. Configuring settings in 3scale" Collapse section "14.8.2.2. Configuring settings in 3scale" 14.8.2.2.1. Troubleshooting 15. Pricing Expand section "15. Pricing" Collapse section "15. Pricing" 15.1. Pricing rules 15.2. Setting pricing rules 15.3. Update existing pricing rules 16. Billing Expand section "16. Billing" Collapse section "16. Billing" 16.1. Listing invoices 16.2. Invoice view Expand section "16.2. Invoice view" Collapse section "16.2. Invoice view" 16.2.1. Invoice details 16.2.2. Editing invoices 16.3. Invoice states 16.4. Automated billing process Expand section "16.4. Automated billing process" Collapse section "16.4. Automated billing process" 16.4.1. On the first day of each month 16.4.2. Every day 16.4.3. Automatic and manual invoices 16.4.4. Mid-month upgrades Expand section "16.4.4. Mid-month upgrades" Collapse section "16.4.4. Mid-month upgrades" 16.4.4.1. Prepaid billing 16.4.4.2. Postpaid billing 16.5. Enable/disable billing/charging per account 16.6. Plans with a trial period 16.7. VAT rate/Sales Tax Expand section "16.7. VAT rate/Sales Tax" Collapse section "16.7. VAT rate/Sales Tax" 16.7.1. Configure VAT rate field 16.7.2. Configure VAT code field 16.7.3. Set VAT values for an account 16.7.4. Invoices with VAT 16.8. Developer Portal view 16.9. Credit card flow Expand section "16.9. Credit card flow" Collapse section "16.9. Credit card flow" 16.9.1. Sign up for a paid plan 16.9.2. Upgrade from a free to a paid plan 16.10. "Billing address" field 17. Email Notifications Expand section "17. Email Notifications" Collapse section "17. Email Notifications" 17.1. Provider notifications 17.2. Developer emails Expand section "17.2. Developer emails" Collapse section "17.2. Developer emails" 17.2.1. Billing email address 18. Billing API VI. Managing developer accounts Expand section "VI. Managing developer accounts" Collapse section "VI. Managing developer accounts" 19. Adding developers Expand section "19. Adding developers" Collapse section "19. Adding developers" 19.1. Create a new developer account 19.2. Set up applications 19.3. Notify the developer 20. Approving developers Expand section "20. Approving developers" Collapse section "20. Approving developers" 20.1. Approve from email notification 20.2. Account approval 20.3. Service approval 20.4. Application approval 21. Changing plans for an app Expand section "21. Changing plans for an app" Collapse section "21. Changing plans for an app" 21.1. Change account plans 21.2. Change service plans 21.3. Change application plans Expand section "21.3. Change application plans" Collapse section "21.3. Change application plans" 21.3.1. More information 22. Contacting developers Expand section "22. Contacting developers" Collapse section "22. Contacting developers" 22.1. Locate the relevant application and account in the system 22.2. Send internal messages to developers 22.3. Contact by other means 23. Customize plans Expand section "23. Customize plans" Collapse section "23. Customize plans" 23.1. Choose the account 23.2. Select the application 23.3. Customize the application plan Expand section "23.3. Customize the application plan" Collapse section "23.3. Customize the application plan" 23.3.1. More information 24. Enable signup 25. Finding applications Expand section "25. Finding applications" Collapse section "25. Finding applications" 25.1. Get the information you need 25.2. Search for the application 25.3. Access application information 26. Inviting developers 27. Unsubscribing developers from a service Expand section "27. Unsubscribing developers from a service" Collapse section "27. Unsubscribing developers from a service" 27.1. Unsubscribing a single developer from services 27.2. Unsubscribing multiple developers from services 28. Suspending applications Expand section "28. Suspending applications" Collapse section "28. Suspending applications" 28.1. Find the application 28.2. Disable the application 28.3. Contact the developer 29. Deleting applications 30. Deleting an API VII. Analytics Expand section "VII. Analytics" Collapse section "VII. Analytics" 31. API analytics Expand section "31. API analytics" Collapse section "31. API analytics" 31.1. Prerequisites 31.2. Determining the metrics and methods to track 31.3. Creating your metrics and methods 31.4. Setting up reports 31.5. Checking that traffic is reported correctly 31.6. Troubleshooting 31.7. Controlling who sees the analytics 31.8. Accessing analytics data by API and email reports 32. Extending analytics Expand section "32. Extending analytics" Collapse section "32. Extending analytics" 32.1. Reasons for customized scripts 32.2. A real-world example 32.3. Example: Customer requirements 32.4. Hands-on implementation Expand section "32.4. Hands-on implementation" Collapse section "32.4. Hands-on implementation" 32.4.1. Winning recipe 32.4.2. Step-by-step guide 32.5. Conclusions 33. Out-of-the-box analytics 34. Response code tracking 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 V. Billing Previous Next
