# Oracle EBS REST API: Integrated SOA Gateway and PL/SQL APIs

> Source: https://netray.co/erp-help/oracle-ebs-rest-api-integrated-soa-gateway-plsql-apis
> Publisher: Netray (netray.co), AI and integration engineering for ERP and manufacturing systems.
> Section: ERP Help

## Short answer

Oracle E-Business Suite exposes APIs through the Integration Repository, which catalogs PL/SQL public APIs, open interfaces, business events and web services. Integrated SOA Gateway (ISG) can deploy selected interface definitions as REST or SOAP services. You find the API, deploy it, grant a user access, and call it over HTTPS with the right application context.

## Kind

how-to

## System

oracle-ebs

## Erp

Oracle E-Business Suite R12

## Module

Integrated SOA Gateway / Integration Repository

## Query

oracle ebs rest api

## Alternate Queries

- oracle ebs api documentation
- oracle ebs api reference
- api in oracle ebs r12
- oracle integrated soa gateway rest service deploy

## Applies To

Oracle E-Business Suite 12.1.3 and 12.2 with Integrated SOA Gateway configured. REST support depends on the release and patch level; consult the Integrated SOA Gateway guide for yours.

## Steps

### How to expose and call an EBS API

**Items:**

- Log in with the Integrated SOA Gateway responsibility and open the Integration Repository. Browse by product family or search for the interface (for example an item or purchase order API).
- Open the interface and read its methods, parameters and the PL/SQL package behind it. This is the primary EBS API reference.
- Confirm ISG is configured by your EBS administrator (web services provider and Oracle HTTP Server setup).
- In the interface details, choose to generate and deploy the service. Select REST (and SOAP if needed) and a service alias.
- Grant the service and method to the user or role that will call it, in the Grants setup on the interface.
- Call the service over HTTPS with basic authentication, supplying the application context (responsibility, application, security group, language and org) in the request.
- Check the response and the concurrent logs; failures usually return a PL/SQL error message and status.
- Test in a non-production instance first; most APIs write data and bypass UI validation only where the API does not enforce it.

## Sections

### The API landscape in EBS

**Body:**

There is no single EBS API document. The Integration Repository is the authoritative catalog: each entry names the interface type (PL/SQL, open interface table, concurrent program, XML Gateway, business event, SOAP or REST service), its parameters and its support level. Prefer interfaces marked as public and supported, since private ones can change with patches.

Open interfaces such as the MTL_SYSTEM_ITEMS_INTERFACE for items, the requisition and PO interfaces and the payables open interface load data into staging tables that a concurrent program then validates and imports. They suit batch loads, while PL/SQL public APIs suit single transactions and can be wrapped as web services.

### Calling a PL/SQL API correctly

**Body:**

EBS APIs depend on session context. Before calling a public API from a database session you normally initialize the application user and responsibility, and for multi-org data set the operating unit policy context. Skipping this produces errors about missing organization context or security.

Through ISG REST, this context is passed in a header block of the request so the service performs the initialization for you. Check the Integrated SOA Gateway guide for the exact structure for your release, because the payload shape is specific to the service alias and method.

**Code:**

-- PL/SQL session setup before calling a public API
BEGIN
  fnd_global.apps_initialize(user_id => :user_id,
                             resp_id => :resp_id,
                             resp_appl_id => :resp_appl_id);
  mo_global.set_policy_context('S', :org_id);
END;

### Security and operations

**Body:**

Treat ISG endpoints like any internet-facing integration: serve over TLS, restrict network access (ideally internal only through a reverse proxy), use a dedicated integration user with minimal responsibilities, and log calls. Unlike Fusion Cloud, EBS has no built-in OAuth for ISG in older releases, so many sites put an API gateway in front.

Performance and error handling are your responsibility: API calls run inside the application database, so large loops hurt online users. For bulk work, use open interfaces and schedule imports.

## Pitfalls

- Calling a private or unsupported API that a patch later changes.
- Skipping apps_initialize or the org context and getting confusing validation errors.
- Exposing ISG services to the internet without a gateway or network restriction.
- Using a personal account instead of a dedicated integration user.
- Assuming every EBS function has a REST service; many are only PL/SQL or open interface.

## Ai Angle

An AI assistant sitting over EBS usually should not write through these APIs unsupervised. A grounded assistant (ERPray is read-only by default, shows its query, and uses human approval for any write-back) can read through SQL or reporting views, and can draft the API payload for a user to approve. On-premises EBS sites, common in aerospace and defense, can host the model on their own GPUs so the data and call logs stay internal. If you only need one integration, a plain ISG service or open interface is simpler than adding AI.

## Faq

### Does Oracle E-Business Suite have a REST API?

**Answer:** Yes, through Integrated SOA Gateway, which can deploy selected Integration Repository interfaces as REST or SOAP services. Coverage depends on your release and what you deploy. There is no universal REST layer over every EBS table.

### Where is the Oracle EBS API documentation?

**Answer:** The Integration Repository inside EBS is the main reference, together with Oracle's Integrated SOA Gateway Implementation Guide and the Open Interfaces and APIs guides for each product on docs.oracle.com.

### What are public APIs in Oracle EBS R12?

**Answer:** They are PL/SQL packages documented and supported for custom use, listed in the Integration Repository. They enforce business validation and are safer than writing directly to base tables.

### Can I use OAuth with EBS REST services?

**Answer:** Basic authentication over TLS is the standard supported mechanism in many releases. For OAuth or token-based security, sites usually add an API gateway or identity layer in front. Verify what your patch level supports.

## Search terms

oracle ebs rest api, oracle ebs api documentation, oracle ebs api reference, api in oracle ebs r12, oracle integrated soa gateway, oracle integration repository, oracle ebs soap web services, oracle ebs plsql public api

---
Talk to an engineer: https://netray.co/contact?intent=erp_ai | Machine catalog: https://netray.co/agent/catalog.json