Create REST API in OIC

Share

Introduction

Creating integrations through APIs is a common requirement in modern cloud architectures. One of the most important capabilities available for integration developers is the ability to Create REST API in OIC (Oracle Integration Cloud). By exposing integrations as REST APIs, organizations allow external systems, mobile applications, and enterprise portals to securely interact with Oracle Fusion applications and other enterprise systems.

Oracle Integration Cloud provides a powerful platform where developers can build integration services visually without writing complex backend code. When developers create REST APIs in OIC, they can expose business functionality such as employee creation, supplier onboarding, order status retrieval, or data synchronization between systems.

In most Oracle Cloud implementations, integrations are exposed as APIs so that multiple systems can reuse the same integration logic. Instead of creating separate integrations for every application, a single REST API can act as a reusable service for many systems.

In this guide, we will explore how to Create REST API in OIC, including architecture, configuration steps, testing methods, common issues, and best practices used in real Oracle integration projects.

What is a REST API in Oracle Integration Cloud?

A REST API in Oracle Integration Cloud is an integration endpoint that allows external systems to interact with enterprise applications using standard HTTP protocols.

REST APIs typically use the following HTTP methods:

  • GET – Retrieve data

  • POST – Create new records

  • PUT – Update existing records

  • DELETE – Remove records

When developers create REST APIs in OIC, the integration usually performs the following operations:

  1. Receive request from external application

  2. Validate the request payload

  3. Transform data if required

  4. Call backend systems such as Oracle Fusion Cloud

  5. Return response to the calling application

This approach allows organizations to build reusable integration services that simplify enterprise system connectivity.

Key Features When You Create REST API in OIC

REST Adapter

The REST Adapter is the primary component used when developers create REST APIs in Oracle Integration Cloud. It enables integrations to expose REST endpoints and also consume external REST services.

Capabilities include:

  • Exposing REST API endpoints

  • Handling JSON and XML payloads

  • Defining request and response structures

  • Supporting multiple HTTP methods

JSON and XML Support

Oracle Integration Cloud supports both JSON and XML formats. Developers simply upload a sample payload, and OIC automatically generates the schema used for mapping.

Security Support

REST APIs created in OIC support multiple authentication mechanisms including:

  • Basic authentication

  • OAuth authentication

  • Token-based authentication

Visual Integration Designer

OIC provides a graphical integration canvas where developers can design the entire API flow visually instead of writing extensive code.

Real-World Integration Use Cases

Employee Creation Integration

Many organizations use employee self-service portals where HR teams onboard new employees. Instead of manually entering employee data into Oracle HCM, the portal can call a REST API.

Integration flow:

  1. HR portal sends employee data to OIC API

  2. OIC validates the request

  3. Integration calls Oracle HCM Cloud API

  4. Employee record is created automatically

Benefits include reduced manual effort and faster employee onboarding.

Supplier Registration API

Organizations often allow vendors to register through supplier portals. Instead of manual data entry, the portal sends supplier information through an API request.

Integration flow:

  1. Vendor portal sends supplier registration request

  2. OIC validates supplier information

  3. Integration calls Oracle ERP supplier API

  4. Supplier record is created automatically

This automation improves supplier onboarding efficiency and reduces manual processing errors.

Order Status API

Customer mobile applications often require real-time order tracking.

Integration flow:

  1. Mobile application sends request to API

  2. OIC retrieves order details from Oracle SCM

  3. Integration returns order status

This approach allows customers to track their orders instantly through mobile applications or web portals.

Architecture When You Create REST API in OIC

A typical architecture when building APIs in Oracle Integration Cloud includes external applications, REST adapters, integration flows, and backend enterprise systems.

Typical flow:

  1. External application sends API request

  2. REST Adapter receives the request

  3. Integration flow processes the request

  4. Backend system performs required operations

  5. Response is returned to the calling application

This architecture allows organizations to centralize integration logic and reuse APIs across multiple systems.

Prerequisites

Before developers create REST APIs in OIC, the following prerequisites should be completed:

  • Access to Oracle Integration Cloud

  • Required roles such as Integration Developer

  • Backend system connectivity

  • Defined JSON request payload

  • Authentication configuration

Step-by-Step Process to Create REST API in OIC

Step 1 – Navigate to Integrations

Login to Oracle Integration Cloud and navigate to:

Navigator → Integrations → Create

Select the integration style App Driven Orchestration.

Enter integration details such as:

  • Name

  • Identifier

  • Version

Click Create.

Step 2 – Configure REST Adapter

Drag the REST Adapter to the integration canvas and configure it as a trigger.

Example configuration:

  • Endpoint Name: createEmployee

  • HTTP Method: POST

  • Request Format: JSON

Upload a sample JSON payload to generate schema.

Example payload:

{ “FirstName”: “string”, “LastName”: “string”, “Email”: “string” }

Step 3 – Configure Backend System

Add an adapter to call backend applications such as Oracle HCM Cloud or Oracle ERP Cloud.

Common adapters used include:

  • REST Adapter

  • ERP Adapter

  • HCM Adapter

Configure the endpoint URL and authentication credentials required to connect to the backend system.

Step 4 – Configure Data Mapping

Use the OIC mapper to map fields between the incoming request payload and backend API structure.

Example mapping:

FirstName → givenName
LastName → familyName
Email → workEmail

This mapping ensures data is properly transferred between the API request and backend system.

Step 5 – Activate the Integration

Once configuration is completed, activate the integration.

Oracle Integration Cloud automatically generates the API endpoint URL.

Example endpoint format:

https://oic-instance.integration.ocp.oraclecloud.com/ic/api/integration/v1/flows/rest/employee_api

External applications can now send API requests to this endpoint.

Testing REST APIs Created in OIC

Testing is typically performed using tools such as Postman.

Example request payload:

{ “FirstName”: “David”, “LastName”: “Lee”, “Email”: “david.lee@company.com” }

Expected response:

{ “Status”: “Success”, “EmployeeId”: “300045” }

During testing, consultants typically verify:

  • API response is received successfully

  • Data is created in backend system

  • Integration completes without errors

Common Implementation Challenges

Common issues encountered while creating REST APIs in Oracle Integration Cloud include:

  • Authentication configuration errors

  • Incorrect request payload structure

  • Backend connectivity issues

  • Incorrect data mapping

These issues can usually be resolved by validating integration configuration and payload structure.

Best Practices

Experienced Oracle integration consultants typically follow these best practices when building REST APIs:

  • Use meaningful API names such as createEmployee or getOrderStatus

  • Implement proper error handling

  • Use API versioning to maintain compatibility

  • Validate input data before processing requests

  • Monitor API executions regularly using OIC monitoring dashboards

Summary

Learning how to Create REST API in OIC is a fundamental skill for Oracle Integration Cloud developers. REST APIs allow enterprise systems, mobile applications, and external platforms to securely interact with enterprise applications.

Oracle Integration Cloud simplifies API development through visual integration design, built-in adapters, and enterprise-grade security. When organizations create REST APIs in OIC, they build scalable integration architectures that support modern cloud-based applications.

In real-world Oracle implementations, REST APIs are commonly used for employee onboarding integrations, supplier onboarding automation, order tracking services, and enterprise data synchronization between systems.

For additional details, refer to the official Oracle documentation:

https://docs.oracle.com/en/cloud/paas/integration-cloud/rest-adapter/index.html

Frequently Asked Questions

What is the purpose of creating REST APIs in Oracle Integration Cloud?

REST APIs allow external systems to securely interact with Oracle integrations and backend enterprise systems using standard HTTP protocols.

Which integration pattern is used when creating REST APIs in OIC?

The App Driven Orchestration integration pattern is typically used because it allows the integration to start with a REST API trigger.

Can REST APIs created in OIC integrate with Oracle Fusion applications?

Yes. REST APIs in OIC commonly integrate with Oracle Fusion HCM, ERP, and SCM systems using REST adapters and Oracle application adapters.


Share

Leave a Reply

Your email address will not be published. Required fields are marked *