LoginSign UpGet Demo
Get accountRequest Demo
DocumentationIntegrationsTools
BlogChangelogPricingLogin
Back

Oracle Fusion API Essential Guide

Aug 11, 2024 • 6 minute read

What type of API does Oracle Fusion provide?

REST APIs

  • REST (Representational State Transfer) is the most common API style used with Oracle currently.
  • Oracle provides REST APIs as a key part of their API offerings.
  • Oracle REST Data Services enables exposing database objects as REST APIs.
  • REST APIs use HTTP methods like GET, POST, PUT, DELETE to perform actions on resources identified by URLs.
  • They are designed to be lightweight, flexible and easy to use.

GraphQL APIs

  • Oracle REST Data Services includes GraphQL functionality to fetch data from Oracle databases using GraphQL queries.
  • GraphQL allows requesting specific data rather than getting fixed data sets from endpoints.
  • It provides more control over the data retrieved and makes evolving APIs easier.

SOAP APIs

  • While less common now, Oracle still supports SOAP APIs in some cases:
  • SOAP (Simple Object Access Protocol) uses XML for message formatting.
  • It relies on other protocols like HTTP for message transmission.
  • SOAP APIs are sometimes used for enterprise applications needing high security and reliability.

Key Considerations

  • REST is the most common API style used with Oracle currently, providing a good balance of simplicity and flexibility.
  • GraphQL is gaining popularity for more complex data fetching needs.
  • SOAP is still supported but less commonly used for new API development with Oracle.
  • The choice depends on specific requirements around data complexity, security needs, and integration scenarios.

Does the Oracle Fusion API have webhooks?

Webhook Support

Yes, the Oracle Fusion API (specifically Oracle Content Management) does support webhooks. There are two types of webhooks mentioned:

  1. Incoming webhooks - Used to receive notifications from external applications.

  2. Outgoing webhooks - Used to automatically push notifications from Oracle Content Management to other applications.

Events You Can Subscribe To

The outgoing webhooks allow you to subscribe to the following types of events:

  1. Asset publishing events
  2. Asset lifecycle events
  3. Site publishing events
  4. Prerendering events
  5. Scheduled jobs events

More specifically, some of the events you can subscribe to include:

  • For asset lifecycle:

    • Content item creation/update/deletion
    • Digital asset creation/update/deletion
    • Taxonomy changes

  • For site publishing:

    • Site published
    • Site unpublished
    • Site status changes

  • For scheduled publishing jobs:

    • Job created
    • Job updated
    • Job cancelled
    • Job started
    • Job completed

  • For prerendering:

    • Prerender events for site detail pages

Configuring Webhooks

Webhooks can be configured in two ways:

  1. Using the REST API endpoints for webhook management

  2. Through the Oracle Content Management web UI under Administration > Integrations > Webhooks

When configuring a webhook, you can specify details like:

  • Name and description
  • Type of webhook
  • Enable/disable status
  • Repository to monitor
  • Asset types to monitor
  • Specific events to subscribe to
  • Payload format (Brief or Detailed)
  • Target URL to send notifications
  • Authentication method

Webhook Payloads

The webhook payloads contain information like:

  • Which webhook was invoked
  • What event was triggered
  • When the event occurred and which user triggered it
  • Details about the entity involved (e.g. content item, digital asset, etc.)

In summary, the Oracle Fusion API (specifically Oracle Content Management) provides comprehensive webhook support for various content and site management events, allowing for real-time integrations and notifications.

Rate Limits and other limitations

Based on the search results provided, here are the key points about the API rate limits for Oracle Fusion API:

General Rate Limiting Approach

Oracle APIs are subject to rate limiting to protect API service usage for all customers. If you reach the API limit for your identity domain type, Oracle returns a 429 error code.

Rate Limits by Identity Domain Type

Oracle has different rate limits based on the identity domain type. The main categories are:

  1. Free
  2. Oracle Apps
  3. Oracle Apps Premium
  4. Premium
  5. External User

The rate limits are defined for different API groups and time intervals:

  • AuthN (Authentication): Limits per second and per minute
  • Token Management: Limits per second and per minute
  • Others: Limits per second and per minute
  • Bulk: Limits per second and per minute
  • Import and export: Limit per day

Specific Rate Limits

Here are some examples of the rate limits (requests per minute) for different domain types:

  • Free: 150 (AuthN), 150 (Token Mgmt), 150 (Others), 200 (Bulk)
  • Oracle Apps: 1000 (AuthN), 1000 (Token Mgmt), 1500 (Others), 200 (Bulk)
  • Premium: 4500 (AuthN), 3400 (Token Mgmt), 5000 (Others), 200 (Bulk)

Other Restrictions

There are additional restrictions for Bulk, Import, and Export operations:

  • Payload size: 1 MB
  • Bulk API: 50 operations limit per call
  • CSV Import: 100K rows limit per CSV & Max file size: 10 MB
  • CSV Export: 100K rows limit

Best Practices

  1. Be aware of the rate limits for your specific identity domain type.
  2. Implement proper error handling for 429 error codes.
  3. For large data operations, consider using Bulk APIs or Import/Export features within the specified limits.
  4. Monitor your API usage to ensure you stay within the allocated limits.

It's important to note that these rate limits are specific to the Oracle Fusion API. Other Oracle services may have different rate limiting policies. Always refer to the most up-to-date documentation for the specific service you're using.

Latest API Version

Based on the search results provided, I do not have specific information about the most recent version of the Oracle Fusion API. The search results contain information about various Oracle cloud services and their APIs, but do not provide a definitive answer about the latest Fusion API version.

However, I can provide some key points to consider:

  1. Oracle regularly updates its cloud services and APIs. The most recent version would likely be associated with the latest release of Oracle Fusion Applications.

  2. To find the most up-to-date information on Oracle Fusion API versions, it's best to:

    • Check the official Oracle Fusion Applications documentation
    • Look for release notes or "What's New" sections for Oracle Fusion Applications
    • Consult Oracle Support if you have access

  3. Oracle provides version information for various APIs related to different cloud services. For example, the search results mention ways to get API versions for services like Planning, Migration, Data Management, Account Reconciliation, Financial Consolidation and Close, and Profitability and Cost Management.

  4. The search results show that Oracle frequently updates its cloud services. For instance, the Oracle API Platform Cloud Service has had multiple releases, with the most recent mentioned being Release 23.3.1 in July 2023.

  5. When working with Oracle APIs, it's important to check the specific documentation for the service you're using, as different Oracle cloud services may have different API versions and update cycles.

To get the most accurate and up-to-date information on the latest version of the Oracle Fusion API, I recommend checking the official Oracle Fusion Applications documentation or contacting Oracle Support directly.

How to get a Oracle Fusion developer account and API Keys?

1. Create an Integration User Account

To access Oracle Fusion APIs, you need to create a special integration user account:

  • Sign in to Oracle Fusion Sales with administrator privileges
  • Create a new user with the following details:
    • Last Name: SERVICE_APP_ICS_ID
    • Username: SERVICE_APP_ICS_ID
    • Person Type: Employee
    • Assign appropriate job roles (e.g. SOA Operator role)
  • Set a password for this integration user

2. Sign Up for Oracle Cloud Infrastructure (OCI) Account

  • Go to oracle.com and sign up for a free OCI account if you don't already have one
  • This will give you access to Oracle's API development and management tools

3. Set Up API Gateway

  • In the OCI Console, go to Developer Services > API Management > Gateways
  • Create a new API Gateway to manage your APIs

4. Create API in OCI

  • In the API Gateway, click "Create API"
  • Specify API details like name, endpoint URL, etc.
  • Upload API specification file if available (e.g. OpenAPI/Swagger)

5. Implement API Backend

  • Develop the backend code to power your API using your preferred language/framework
  • Test the backend code thoroughly

6. Deploy and Publish API

  • Deploy the API to make it accessible
  • Configure security, monitoring, and governance settings in API Gateway
  • Publish API to developer portal if desired

What can you do with the Oracle Fusion API?

Based on the search results, here are the key data models you can interact with using the Oracle Fusion API, along with what is possible for each:

Interaction API

  • Allows communication between the toolbar and Oracle Fusion Service during an interaction
  • Key methods include:
    • newCommEvent: Notifies the application of a new communication event
    • startCommEvent: Notifies when an agent accepts an event
    • closeCommEvent: Notifies when an event is closed
    • transferCommEvent: Informs of a communication transfer
    • upgradeCommEvent: Notifies when a new channel is added to an engagement
    • downgradeCommEvent: Notifies when a channel is removed from an engagement
    • getCustomerData: Retrieves customer or related data

REST API for Sales and Fusion Service

  • Allows interaction with the following data models:
    • Child Interactions
    • Interaction Participants
    • Interaction References
    • Large Object (LOB) Attributes - Payload
    • Smart Actions

Fusion Analytics Data Models

  • Provides prebuilt, connected 360-degree views of key business entities
  • Combines data from Fusion Cloud Applications and other sources
  • Supports analytics for:
    • ERP (Enterprise Resource Planning)
    • SCM (Supply Chain Management)
    • HCM (Human Capital Management)
    • CX (Customer Experience)

Extraction/Export Options

  • Fusion Desktop Integration: Exports data to Excel/CSV from application screens
  • Export Management: Extracts CX data to CSV files
  • HCM Extracts: Extracts HCM data to various formats like CSV, XML, Excel
  • Item/Product Data Publication: Publishes item objects to XML
  • BICC (BI Cloud Connector): Extracts bulk data to CSV for ERP, SCM, CX
  • REST API: Extracts data to JSON format
  • SOAP Services: Extracts data to XML format

Key Points

  • Different pillars (HCM, CX, ERP, SCM) have purpose-built extract utilities best suited for their objects/entities
  • BICC is recommended for large volume and incremental extracts for ERP and SCM
  • REST/SOAP APIs are recommended only for real-time integrations, not high-volume extracts
  • Consider factors like data volume, frequency, performance when choosing an extract option

Ship integrations on autopilot

Get Demo
Resources
DocumentationIntegrationsAPI Integration GuidesBlogChangelogPricingSupport
Legal
Terms of ServicePrivacy PolicyGoogle API
© 2024 Playbook Software Inc.