Explore the Oracle Integration APIs

Oracle Integration provides administrative APIs, developer APIs, and endpoints for components.

Oracle Integration APIs

Every Oracle Integration instance includes access to the following APIs.

A diagram illustrates the APIs and endpoints for Oracle Integration. The Oracle Cloud is associated with Oracle Cloud Infrastructure APIs. Within Oracle Cloud is the Oracle Integration instance, which is associated with the Oracle Integration Administrative API and which you use to administer and perform lifecycle operations on an Oracle Integration instance. Within the Oracle Integration instance is a box for managing integrations. This task is associated with the Developer API for Oracle Integration 3, which you use to perform day-to-day tasks in an Oracle Integration instance. Finally, also within the Oracle Integration instance is a box for running integrations. This task is associated with integration endpoints, which call integrations from anywhere. These endpoints are available when a connection is based on the REST Adapter or SOAP Adapter.

API Typical users Description Alternate names

Oracle Cloud Infrastructure APIs

OCI tenant and domain administrators

The Oracle Cloud Infrastructure APIs contain service-specific APIs for Oracle Cloud Infrastructure services.

Use the Oracle Cloud Infrastructure APIs to perform operations for each service.

See API Reference and Endpoints in the Oracle Cloud Infrastructure Documentation.

Control plane APIs

Oracle Integration Administrative API

OCI tenant and domain administrators

Use the Oracle Integration Administrative API to perform lifecycle operations for an Oracle Integration instance, including provisioning an instance, managing custom endpoints, and extending data retention.

This API provides access to the activities that you can perform in the user interface of the Oracle Cloud Infrastructure Console. A CLI is also available.

See Oracle Integration API.

Control plane API

Provisioning and administering APIs

OCI lifecycle operations API

Developer API for Oracle Integration 3

Oracle Integration instance users

Use the Developer API for Oracle Integration 3 to perform day-to-day tasks in an Oracle Integration instance, including interacting with integrations and their related components.

This API provides access to the activities that you can perform in the Oracle Integration user interface.

See Oracle Integration 3 REST API.

Oracle Integration instance API

Built-in API

Factory API

Application API

Integration endpoints

Oracle Integration instance users: integration developers

Use an integration endpoint to call an integration from anywhere.

An integration endpoint is available only when a connection in an integration uses the REST Adapter, SOAP Adapter, or another adapter that exposes inbound REST or SOAP endpoints.

Customer-built APIs

Dynamic APIs

Process Automation APIs

When you enable Process Automation in your Oracle Integration instance, you have access to the following APIs.

A diagram illustrates APIs and an endpoint for Process Automation in Oracle Integration. To manage processes and decisions, work with the Developer API for Process Automation, which you use to perform day-to-day administrative tasks in an Oracle Integration instance. Use a decision application endpoint to call decision applications from integrations, and use process application endpoints to call process applications from integrations.

API Typical users Description Alternate names

Developer API for Process Automation

Oracle Integration instance users

Use the Developer API for Process Automation to automate and manage business processes.

This API provides access to the activities that you can perform in the Process Automation user interface.

See OCI Process Automation REST API.

Process Automation instance API

Built-in API

Factory API

Application API

Decision application endpoints

Oracle Integration instance users: decision application developers

Use a decision application endpoint to call a decision application from anywhere.

n/a

Process application endpoints

Oracle Integration instance users: process application developers

Use a process application endpoint to call a process application from anywhere.

n/a

File Server APIs

When you enable File Server in your Oracle Integration instance, you have access to the following APIs.

A diagram illustrates APIs and an endpoint for File Server in Oracle Integration. To manage files, work with the Developer API for File Server, which you use to perform day-to-day tasks in an Oracle Integration instance. Also, use a File Server endpoint to access File Server from any FTP client.

API Typical users Description Alternate names

Developer API for File Server

Oracle Integration instance users

Use the Developer API for File Server to configure and administer File Server. File Server is an SFTP-compliant repository that is connected to an Oracle Integration instance.

This API provides access to the activities that you can perform in the Oracle Integration user interface for File Server.

See File Server in Oracle Integration 3 REST API.

Oracle Integration instance API for File Server

Built-in API

Factory API

Application API

File Server endpoint

Oracle Integration instance users

Use the File Server endpoint to access File Server from any integration.

n/a