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

How to expose and call an EBS API

1. 1Log 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).
2. 2Open the interface and read its methods, parameters and the PL/SQL package behind it. This is the primary EBS API reference.
3. 3Confirm ISG is configured by your EBS administrator (web services provider and Oracle HTTP Server setup).
4. 4In the interface details, choose to generate and deploy the service. Select REST (and SOAP if needed) and a service alias.
5. 5Grant the service and method to the user or role that will call it, in the Grants setup on the interface.
6. 6Call the service over HTTPS with basic authentication, supplying the application context (responsibility, application, security group, language and org) in the request.
7. 7Check the response and the concurrent logs; failures usually return a PL/SQL error message and status.
8. 8Test in a non-production instance first; most APIs write data and bypass UI validation only where the API does not enforce it.

Calling a PL/SQL API correctly

-- 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;

Common 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.