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 Expand section "5. Personal settings" Collapse section "5. Personal settings" 5.1. Types of 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.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 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. About service discovery 9. Using service discovery 10. Configuring service discovery Expand section "10. Configuring service discovery" Collapse section "10. Configuring service discovery" 10.1. Prerequisites 10.2. Configuring with RH SSO Expand section "10.2. Configuring with RH SSO" Collapse section "10.2. Configuring with RH SSO" 10.2.1. Using OpenShift OAuth server 10.2.2. Using RH SSO server (Keycloak) 10.3. Configuring without RH SSO 10.4. Making a service discoverable IV. Access control Expand section "IV. Access control" Collapse section "IV. Access control" 11. Defining your API (Methods And Metrics) Expand section "11. Defining your API (Methods And Metrics)" Collapse section "11. Defining your API (Methods And Metrics)" 11.1. Manually add methods and metrics 11.2. Import your methods and metrics automatically 12. Application plans Expand section "12. Application plans" Collapse section "12. Application plans" 12.1. How to create an application plan 12.2. Setting up a default application plan 13. Mapping rules 14. Provisioning paid plans Expand section "14. Provisioning paid plans" Collapse section "14. Provisioning paid plans" 14.1. Make decisions about your pricing model 14.2. Set up an application plan with your pricing rules 14.3. Create further pricing tiers 14.4. Provision the paid plans 14.5. More information 15. Provisioning rate limits Expand section "15. Provisioning rate limits" Collapse section "15. Provisioning rate limits" 15.1. Go to the application plan 15.2. Set the rate limits 15.3. Update the application plan 15.4. Put the new rate limits into action 15.5. More information V. Billing Expand section "V. Billing" Collapse section "V. Billing" 16. Configuring Billing Settings Expand section "16. Configuring Billing Settings" Collapse section "16. Configuring Billing Settings" 16.1. Billing modes (Charging & Gateway) 16.2. Charging enabled (Charging & Gateway) 16.3. Currency (Charging & Gateway) 16.4. Invoice footnote (Charging & Gateway) 16.5. Text to show if VAT/Sales Tax is 0% (Charging & Gateway) 16.6. Billing periods for invoice ids (Charging & Gateway) 16.7. Credit Card Policies 16.8. Credit Card Gateways Expand section "16.8. Credit Card Gateways" Collapse section "16.8. Credit Card Gateways" 16.8.1. Adyen integration Expand section "16.8.1. Adyen integration" Collapse section "16.8.1. Adyen integration" 16.8.1.1. Prerequisites 16.8.1.2. Configuring Adyen integration 16.8.2. Stripe integration (recommended) Expand section "16.8.2. Stripe integration (recommended)" Collapse section "16.8.2. Stripe integration (recommended)" 16.8.2.1. Prerequisites 16.8.2.2. Getting your API keys from Stripe 16.8.2.3. Configuring settings in 3scale 16.8.3. Braintree integration Expand section "16.8.3. Braintree integration" Collapse section "16.8.3. Braintree integration" 16.8.3.1. Getting your API keys from Braintree 16.8.3.2. Configuring settings in 3scale Expand section "16.8.3.2. Configuring settings in 3scale" Collapse section "16.8.3.2. Configuring settings in 3scale" 16.8.3.2.1. Troubleshooting 17. Pricing Expand section "17. Pricing" Collapse section "17. Pricing" 17.1. Pricing rules 17.2. Setting pricing rules 17.3. Update existing pricing rules 18. Billing Expand section "18. Billing" Collapse section "18. Billing" 18.1. Listing invoices 18.2. Invoice view Expand section "18.2. Invoice view" Collapse section "18.2. Invoice view" 18.2.1. Invoice details 18.2.2. Editing invoices 18.3. Invoice states 18.4. Automated billing process Expand section "18.4. Automated billing process" Collapse section "18.4. Automated billing process" 18.4.1. On the 1st day of each month 18.4.2. Every day 18.4.3. Automatic and manual invoices 18.4.4. Mid-month upgrades Expand section "18.4.4. Mid-month upgrades" Collapse section "18.4.4. Mid-month upgrades" 18.4.4.1. Prepaid billing 18.4.4.2. Postpaid billing 18.5. Enable/disable billing/charging per account 18.6. Plans with Trial Period 18.7. VAT rate/Sales Tax Expand section "18.7. VAT rate/Sales Tax" Collapse section "18.7. VAT rate/Sales Tax" 18.7.1. Configure VAT rate field 18.7.2. Configure VAT code field 18.7.3. Set VAT values for an account 18.7.4. Invoices with VAT 18.8. Developer portal view 18.9. Credit card flow Expand section "18.9. Credit card flow" Collapse section "18.9. Credit card flow" 18.9.1. Sign up for a paid plan 18.9.2. Upgrade from a free to a paid plan 18.10. "Billing address" field 19. Email Notifications Expand section "19. Email Notifications" Collapse section "19. Email Notifications" 19.1. Provider notifications 19.2. Developer emails Expand section "19.2. Developer emails" Collapse section "19.2. Developer emails" 19.2.1. Billing email address 20. Billing API VI. Managing developer accounts Expand section "VI. Managing developer accounts" Collapse section "VI. Managing developer accounts" 21. Adding developers Expand section "21. Adding developers" Collapse section "21. Adding developers" 21.1. Create a new developer account 21.2. Set up applications 21.3. Notify the developer 22. Approving developers Expand section "22. Approving developers" Collapse section "22. Approving developers" 22.1. Approve from email notification 22.2. Account approval 22.3. Service approval 22.4. Application approval 23. Changing plans for an app Expand section "23. Changing plans for an app" Collapse section "23. Changing plans for an app" 23.1. Change account plans 23.2. Change service plans 23.3. Change application plans Expand section "23.3. Change application plans" Collapse section "23.3. Change application plans" 23.3.1. More information 24. Contacting developers Expand section "24. Contacting developers" Collapse section "24. Contacting developers" 24.1. Locate the relevant application and account in the system 24.2. Send internal messages to developers 24.3. Contact by other means 25. Customize plans Expand section "25. Customize plans" Collapse section "25. Customize plans" 25.1. Choose the account 25.2. Select the application 25.3. Customize the application plan Expand section "25.3. Customize the application plan" Collapse section "25.3. Customize the application plan" 25.3.1. More information 26. Enable signup 27. Finding applications Expand section "27. Finding applications" Collapse section "27. Finding applications" 27.1. Get the information you need 27.2. Search for the application 27.3. Access application information 28. Inviting developers 29. Unsubscribing developers from a service Expand section "29. Unsubscribing developers from a service" Collapse section "29. Unsubscribing developers from a service" 29.1. Unsubscribing a single developer from services 29.2. Unsubscribing multiple developers from services 30. Suspending applications Expand section "30. Suspending applications" Collapse section "30. Suspending applications" 30.1. Find the application 30.2. Disable the application 30.3. Contact the developer 31. Deleting applications VII. Analytics Expand section "VII. Analytics" Collapse section "VII. Analytics" 32. API analytics Expand section "32. API analytics" Collapse section "32. API analytics" 32.1. Prerequisites 32.2. Determining the metrics and methods to track 32.3. Creating your metrics and methods 32.4. Setting up reports 32.5. Checking that traffic is reported correctly 32.6. Troubleshooting 32.7. Controlling who sees the analytics 32.8. Accessing analytics data by API and email reports 33. Exporting analytics Expand section "33. Exporting analytics" Collapse section "33. Exporting analytics" 33.1. Reasons for customized scripts 33.2. A real-world example 33.3. Example: Customer requirements 33.4. Hands-on implementation Expand section "33.4. Hands-on implementation" Collapse section "33.4. Hands-on implementation" 33.4.1. Winning recipe 33.4.2. Step-by-step guide 33.5. Conclusions 34. Out-of-the-box analytics Expand section "34. Out-of-the-box analytics" Collapse section "34. Out-of-the-box analytics" 34.1. Find the application 34.2. Understand the application display 34.3. Use the menu to access the full screen statistics view 35. 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 I. Account settings Previous Next