Oracle Integration Cloud (OIC) is a powerful integration platform that enables organizations to connect Oracle Fusion Cloud Applications, third-party applications, databases, and external services. One of its most important capabilities is REST API integration, which allows applications to exchange information through lightweight HTTP-based services.
Businesses use REST APIs to automate processes, synchronize data, retrieve information, and connect different enterprise applications. With the Oracle Integration Cloud REST Adapter, developers can expose REST endpoints and consume external REST APIs without building the entire integration infrastructure from scratch.
In this guide, we will explain Oracle Integration Cloud REST API integration, including REST API concepts, adapter configuration, step-by-step implementation, authentication, data mapping, error handling, and practical examples.
What Is REST API Integration in Oracle Integration Cloud?
REST stands for Representational State Transfer. It is an architectural style used to build web services that communicate over HTTP.
REST APIs allow applications to exchange data using HTTP methods and commonly support JSON and XML payloads.
Oracle Integration Cloud provides a REST Adapter that supports two major integration scenarios:
- Exposing REST APIs through OIC so external applications can invoke integrations.
- Consuming external REST APIs so OIC can communicate with third-party applications and services.
For example, an organization can receive customer information through an OIC REST endpoint, transform the data, and send it to Oracle Fusion ERP.
Common HTTP Methods Used in REST API Integration
Understanding HTTP methods is essential when developing REST integrations.
| HTTP Method | Purpose | Example |
|---|---|---|
| GET | Retrieve information | Get employee details |
| POST | Create a resource or submit data | Create a supplier |
| PUT | Replace or update a resource | Update customer information |
| PATCH | Partially update a resource | Update employee email |
| DELETE | Delete a resource | Delete a record |
The supported methods depend on the target API.
Key Features of the OIC REST Adapter
The REST Adapter provides several capabilities for building API-based integrations.
1. REST API Exposure: Developers can expose OIC integrations as REST endpoints for external applications.
2. REST API Consumption: OIC can invoke external REST services and exchange information with third-party applications.
3. JSON and XML Support: The adapter supports commonly used payload formats for API communication.
4. Authentication: It supports applicable authentication mechanisms such as Basic Authentication, OAuth, and other configured security policies.
5. Data Mapping: OIC provides visual mapping tools to transform source data into the target API structure.
6. Parameter Handling: Developers can configure query parameters, headers, and path parameters according to the API requirements.
Step-by-Step Guide to Creating REST API Integration in OIC
Let’s understand how to create a REST API integration using Oracle Integration Cloud.
Step 1: Create a REST Adapter Connection
Log in to your Oracle Integration Cloud instance.
Navigate to the Design section and open Connections.
Click Create and search for the REST Adapter.
Enter a meaningful connection name, such as:
CUSTOMER_REST_CONNECTION
Select the appropriate role and configure the required connection settings.
If the connection is intended to invoke an external API, provide the required endpoint and authentication configuration according to the adapter’s setup options.
Test the connection and save it after successful validation.
Step 2: Create a New Integration
Navigate to the Integrations section and create a new integration.
Select the appropriate integration pattern.
For an API-driven workflow, an app-driven orchestration is commonly used.
Enter the integration name:
CUSTOMER_REST_API_INTEGRATION
A meaningful integration name helps developers identify the integration when managing multiple workflows.
Step 3: Configure the REST Trigger
Drag the REST Adapter into the trigger section of the integration.
Select the appropriate REST connection.
Configure the endpoint details, including:
- Relative resource URI.
- HTTP method.
- Request payload format.
- Response payload format.
- Query parameters.
- Path parameters.
For example, you can configure an endpoint such as:
/customers
with the POST method to receive customer information.
Step 4: Define the Request Payload
The request payload defines the structure of information received by the REST API.
For example:
{
"customerName": "ABC Technologies",
"email": "contact@example.com",
"country": "India",
"customerType": "Business"
}Use a representative JSON sample to define the request structure in the REST Adapter wizard.
OIC uses this structure to generate the corresponding schema for mapping and processing.
Step 5: Add a REST Invoke Connection
After configuring the trigger, add another REST Adapter as an invoke activity.
Select the connection representing the external REST API that the integration needs to call.
Configure the target API operation, including its resource path, HTTP method, headers, and request and response structures.
For example, the integration may send customer information to an external CRM API.
Step 6: Configure Data Mapping
The mapper connects the source request structure with the target API request structure.
For example:
| Source Field | Target Field |
|---|---|
| customerName | name |
| customerEmail | |
| country | countryName |
| customerType | accountType |
OIC also provides transformation functions for string manipulation, date conversion, conditional mapping, and other data-processing requirements.
Correct mapping ensures that the target application receives information in the expected format.
Step 7: Configure Headers and Parameters
REST APIs often require additional HTTP headers and parameters.
Common headers include:
- Content-Type
- Accept
- Authorization
For example, an API may require JSON content and a specific authentication policy.
Query parameters can filter records:
/customers?status=active
Path parameters can identify individual resources:
/customers/{customerId}
Configure these values according to the external API documentation.
Step 8: Implement Error Handling
Error handling is important for building reliable REST integrations.
Use scopes and fault handlers to manage failures that occur during API execution.
Common REST API errors include:
- HTTP 400: Bad request.
- HTTP 401: Authentication failure.
- HTTP 403: Insufficient permissions.
- HTTP 404: Resource not found.
- HTTP 429: Too many requests.
- HTTP 500: Internal server error.
Depending on the error, the integration can capture fault information, log relevant details, send notifications, or return an appropriate response to the calling application.
Avoid automatically retrying permanent errors such as invalid payloads without correcting the underlying issue.
Step 9: Configure the REST Response
After the external API returns a response, OIC can map the result into a response structure for the original caller.
For example:
{
"status": "SUCCESS",
"message": "Customer created successfully",
"customerId": "CUST1001"
}The response should communicate the processing result clearly without exposing unnecessary internal application details.
Step 10: Validate, Activate, and Test
Validate the integration to identify configuration and mapping issues.
After successful validation, activate the integration.
You can test the REST endpoint using Postman or another API testing tool.
Test different scenarios, including:
- Valid customer information.
- Missing mandatory fields.
- Invalid authentication.
- Incorrect parameter values.
- External API failures.
- Unexpected response structures.
Testing multiple scenarios helps identify problems before production deployment.
Real-World REST API Integration Examples in OIC
REST APIs are commonly used in enterprise integration projects.
1. Oracle Fusion ERP Integration
An organization can expose an OIC REST endpoint to receive supplier information from an external procurement application and process it using supported Oracle ERP Cloud services.
2. Oracle HCM Integration
OIC can consume or expose REST APIs to exchange employee information between Oracle Fusion HCM and external HR applications.
3. Third-Party CRM Integration
Customer records from a CRM application can be synchronized with Oracle Fusion ERP through REST API calls.
4. E-Commerce Integration
An e-commerce platform can send order details to OIC through a REST endpoint. OIC can transform the information and send it to the appropriate enterprise application.
Best Practices for OIC REST API Integration
Follow these recommendations when developing REST integrations:
- Use meaningful connection and integration names.
- Validate request and response payloads.
- Use secure authentication mechanisms.
- Avoid exposing sensitive information in API responses.
- Implement proper fault handling.
- Minimize unnecessary API calls.
- Consider pagination and rate limits for large datasets.
- Use business identifiers for tracking.
- Test successful and failed scenarios.
- Document API endpoints and dependencies.
Conclusion
Oracle Integration Cloud REST API integration is an essential capability for connecting modern enterprise applications and automating business processes. With the REST Adapter, developers can expose APIs, consume external services, transform data, and exchange information between Oracle Fusion Applications and third-party systems.
To build reliable REST integrations, developers should understand HTTP methods, adapter configuration, authentication, request and response structures, data mapping, error handling, and monitoring.
Whether you are preparing for an Oracle Integration Cloud interview or working on real-world integration projects, practicing REST API integrations with OIC and Postman can help strengthen your technical skills.
IQ Stream Technologies provides Oracle technology learning resources to help professionals understand OIC concepts, REST API development, adapters, and enterprise integration techniques.
