Table of Contents
- Title and Copyright Information
- Preface
-
1
Get Started with Oracle API Platform Cloud Service
- Learn About Oracle API Platform Cloud Service
- Learn About the Components of Oracle API Platform Cloud Service
- Before You Begin with Oracle API Platform Cloud Service
- How to Begin with Oracle API Platform Cloud Service Subscriptions
- Access Oracle API Platform Cloud Service
- Create an Oracle API Platform Cloud Service Instance
- Access the Oracle API Platform Cloud Service Management and Developer Portals
- Find Your Client ID and Client Secret
- Finding the Scope for the Oracle API Platform Cloud Service REST APIs
- About Oracle API Platform Cloud Service Roles, Resources, Actions, and Grants
-
2
Administer Oracle API Platform Cloud Service
- Typical Workflow for Administering Oracle API Platform Cloud Service
- Use the SSL Certificate Import Utility
- Manage Users and Groups with the Infrastructure Console
- Manage Users and Groups with the Infrastructure Classic Console
- Manage Roles
- Update Platform Settings
- Customize the Look and Feel of the Developer Portal
- Add or Modify Developer Portal Language Resources
- Manage Custom Pages in the Developer Portal
- Deploy the Developer Portal On Premise
- Set the Time Display
- Configure Accessibility Preferences for Oracle API Platform Cloud Service
- Configure OAuth Providers
- Delete an Oracle API Platform Cloud Service Instance
-
3
Manage Gateways
- Typical Workflow for Managing Gateways with Oracle API Platform Cloud Service
- Understand Gateways and Gateway Nodes
- System Requirements for On-Premises Gateway Installation
- Gateway Node Topologies
- Create a Gateway Node on Oracle Cloud Infrastructure
- Create a Logical Gateway
- Download the Gateway Node Installer
- Install a Gateway Node
- Update Gateway Node Properties
- View Gateway Node Status
-
Configure Gateway Node Domains
- Sign into the WebLogic Adminstration Console for a Gateway Node Domain
- Supported WebLogic Authentication Providers
- Configure WebLogic Authentication Providers
- Configure SSL Certificates to Pass Requests to Services Over HTTPS
- Configure the Socket Timeout When Calling Backend Services
- Gateway Node Lockdown
- Configure Gateway Node Firewall Properties in the WebLogic Adminsitration Console
- Additional Firewall Properties
- Configure Analytics Properties
- About Logstash Retry Logs
- Enable Analytics in Production Environments
- Manage Gateway Settings
- Configure Gateway Firewall Properties
- Manage Gateway Nodes in the API Platform Cloud Service Management Portal
- Reset Gateway User Password and Reactivate Polling
- Manage Gateway Grants
- Work with Deployed Endpoints
- Upgrade a Gateway
- Delete a Logical Gateway
-
4
Manage APIs
- Typical Workflow for Managing APIs with Oracle API Platform Cloud Service
- About the Oracle Apiary Integration
- Understand the APIs List Page
- Create an API
- View API Details
- Edit an API Description
- Upload an API Icon
- Clone an API
- Change the State of an API
- Link an Oracle Apiary Specification
-
Implement APIs
- Understand Policies
- Configure the Request Pipeline
- Configure the Response Pipeline
- Policy Placement
-
Apply Policies
- Configure the API Request URL
- Configure the Service Request URL
- Apply OAuth 2.0 Policies
- Apply Key Validation Policies
- Apply Basic Authentication Policies
- Applying IP Filter Validation Policies
- Apply Outbound WSS Username Token Policies
- Apply CORS Policies
- Apply Inbound WSS Username Token Policies
- Apply API Throttling–Delay Policies
- Apply Application Rate Limiting Policies
- Apply API Rate Limiting Policies
- Apply Header Field Filtering Policies
- Apply Interface Filtering Policies
- Apply Redaction Policies
- Apply Header Validation Policies
- Apply Request Payload Validation Policies
- Apply Method Mapping Policies
- Apply REST to SOAP Policies
- Apply Header-Based Routing Policies
- Apply Application-Based Routing Policies
- Apply Gateway-Based Routing Policies
- Apply Resource-Based Routing Policies
- Apply Service Callout 2.0 Policies
- Apply Groovy Script Policies
- Apply Logging Policies
- Work with Draft Policies
- Access Context Variables Using Groovy Notation
- Deploy Endpoints
- Manage API Grants
- Manage API Entitlements
- Publish APIs
- Delete an API
-
5
Manage Services and Service Accounts
- Manage Service Accounts
- Manage Services
- Understand the Relationship Between APIs, Services, and Service Accounts
- 6 Manage Plans
- 7 Manage Applications
- 8 Use Analytics
-
9
Frequently Asked Questions for Oracle API Platform Cloud Service
- How is the Oracle Data Model Superior to its Competitors?
- Are API Manager, API Catalog, and API Gateway used with API Platform?
- Does My Service Stop when the Number of Allowed Requests are Exceeded?
- Does API Platform Have API Harvesting Capabilities?
- Can I Use APIs to Automate or Extend the Capabilities of API Platform?
- Are Unknown Developer Portal Users Supported?
- Is API Cloning Supported?
- Are SOAP APIs Supported?
- Can Requests be Routed to the Nearest Gateway or to a Different Instance of the Underlying Service?
- Can I View a History of User Activity or API Iterations?
- Does the API Gateway Allow Auto Scaling?
- Is API Runtime Call Traffic Sent from the Gateway to Management Service?
- What Tools are Available to Assist with the Design and Creation of REST, SOAP, and Other APIs?
- How is Documentation Created and Reviewed in the API User Portal?
- How Do I Configure Keystores on a Gateway Node?
- How Do I Obtain a CA-Signed Certificate for the Management Server OTD?
- What Are the Prerequisites for Installing a Gateway Node in Production Mode?
-
10
Troubleshooting Oracle API Platform Cloud Service
-
Troubleshoot Gateway Issues
- Where can I find Gateway related documentation?
- Where can I find Gateway related logs?
- What are the pre-requisite checks to perform on the host machine before installation
- How do I use a custom temp directory for Gateway installation
- How do I set a custom hostname verifier
- I want to change the socket timeout values for backend services calls
- I want to increase the maximum number of total connections to backend services
- I want to increase callout retry times
- I want to change Gateway APIFirewall settings
- I want to change Gateway overload protection
- I want to stop the server shutting down due to overload panic action
- I want to enable the HTTP access log
- Reset managementServiceConnectionProxy in already configured Gateway
- What to do when Gateway installation fails
- The Gateway start action fails to start the servers
- The Gateway restart action fails to restart the servers
- The Gateway join actions fails
- The Gateway fails to poll
- Does Oracle API Platform Cloud Service support proxy with credentials
- Slow Gateway performance
- Create user in the Gateway realm to use Basic Auth
- Create a group and add the user to it for Basic Auth
- Change the Gateway WebLogic admin and Derby DB credentials
- Cannot connect to Gateway Derby DB
- Allow enabling cookies to be passed to the backend service
- Update Gateway threat protection configurations
- Show threat protection alarm description in logs
- WebLogic vulnerability attack, 503 Service Unavailable, Gateway start getting killed
-
Troubleshoot Gateway Issues