On-Premises REST API Support with the Agent

The REST Adapter-specific connection can be configured to use the connectivity agent to consume REST APIs that are hosted either on a customer's on-premises network or on a private cloud, are truly private APIs, and are not exposed as public APIs that can be consumed over the internet.

Oracle Integration provides the agent framework to enable you to create integrations and exchange messages between on-premises applications and Oracle Integration. You can integrate on-premises REST APIs with Oracle Integration with the on-premises connectivity agent. Once you create an agent group and install the on-premises agent, you can create and configure a REST Adapter connection on the Connections page as follows:

  • Select REST API Base URL or Swagger Definition URL from the Connection Type list and enter the appropriate URL in the Connection URL field. No other connection types are supported.

  • Select Basic Authentication, OAuth Client Credentials, OAuth Resource Owner Password Credentials, OAuth Custom Two Legged Flow, or No Security Policy from the Security Policy list. No other security policies are supported.

  • Select the previously-created agent group in the Select an Agent Group dialog.

  • Note that the token server cannot be on-premises. If the provider is accessible through the cloud, you must get the bearer token in the cloud and perform the agent-based request invocation by setting the authorization header.

For conceptual information about the on-premises agent, see About Agents and Integrations Between On-Premises Applications and Oracle Integration. For information about creating an agent group and installing the on-premises agent, see Manage the Agent Group and the On-Premises Connectivity Agent.