20 FAQs

APIs

Do I need to supply the x-hotelid in the header as well as the URL?

Yes, the header parameter is used for authorization where any hotelIds in the URL refer to the resource being accessed.

How can I call early adopter (v0) APIs and what are the implications?

See the Early Adopter API Program topic for details.

How long after a v0 API is promoted to v1 will I have to repoint my integration to v1?

The v0 Early Adopter APIs have been officially deprecated. We recommend reviewing your integration to ensure that no endpoints reference v0 in the path URL.

Do I need to request an OAuth each time I make an API call?

No, please avoid doing this. Instead of requesting a token repeatedly, just request a token once per user and keep using that same token for the lifetime of the token. For information about managing oAuth tokens, see Property APIs. Additional calls are unnecessary and may add to your per cost calls.

Is the Oracle Hospitality product version number the same as the OHIP developer portal version?

No, the OHIP developer portal version, which is visible by clicking the My Profile dropdown at the top right of the Developer Portal, relates only to the OHIP version, not the version of any APIs available through OHIP.

Billing

If I am using Oracle Hospitality Integration Cloud Service, how do I view my billing and API usage?

There are two ways to view your billing and metrics:

  1. Oracle Cloud Console administrators can view their usage and invoices in the Oracle Customer Center (oracle.com).

  2. Oracle Cloud Console administrators can also view this information in their monthly email invoices.

Will all API calls be counted in my API charged usage for Oracle Hospitality Integration Cloud Service?

No, 429, 500, 502, 503, and 504 errors will not be charged. You can view the non-billable usage in API Analytics.

How am I charged for consuming events?

With the streaming API, partners are charged for each event consumed. When replaying events, partners are charged the first time they replay an event. With the polling API, partners are charged for each API call made. For further details, please see https://www.oracle.com/contracts/cloud-services/

For any other questions about Oracle invoicing, refer to Oracle Invoicing FAQ | Oracle United Kingdom.

I am using a Sandbox environment for development. Are my API calls free of charge?

API usage is billed based on consumption, regardless of the environment: Sandbox, Non-Production, or Production. Usage charges are invoiced at the beginning of each month for the previous month. Please note that the charges reflect the total accumulated cost and are not calculated per hotel or per chain.

Disclaimer:

Your Partner Developer Portal includes several default Sandbox environments, some of which have streaming enabled. These Sandboxes are shared across more than 1,300 companies and 5,000 developers and may experience cross-activity, such as profile creation, reservation updates, or charge additions.

If Business Events (via polling or streaming) are active, such shared activity may incur commercial charges as events are queued for your application's consumption. If you do not require these interactions, it is strongly recommended to unsubscribe from Business Events after completing your testing and reactivate them only when necessary.

I have a free-tier Oracle Cloud account. Can I use OHIP?

No. OHIP (Oracle Hospitality Integration Platform) is available only through a paid subscription under a pay-as-you-go model. You cannot add a paid OHIP subscription to a free-tier Oracle Cloud account.

When I join Oracle Cloud, I see an option to request free credits for my account. Can I use those for OHIP?

The Oracle Hospitality Integration Platform does not support the use of free credits for startups or other accounts. Since OHIP API usage costs are relatively minimal, free credits are not applicable. Please refer to the Costs section for detailed pricing information.

I have subscribed to the 10,000-transaction plan, which is labeled as a pay-as-you-go model. Will my integration stop once I reach 10,000 calls, or can I set a hard limit of 20,000 calls?

The 10,000-transaction figure represents the number of calls included in your monthly billing cycle. If you exceed this threshold, for example, by making 10,001 calls, the additional calls will be billed at approximately USD 20 per 10,000 calls or proportionally for fewer.

Currently, there are no system-enforced hard limits, and it is not possible to manually set one. However, you can configure usage alerts within your application to notify you when you approach a specific call count.

Please note that implementing hard limits on your side may cause your systems to fall out of sync, potentially leading to missed data or inaccurate reporting in shared statistics.

I am a startup company and would like to know if there are any alternative plans or subscription options available for accessing the Hospitality APIs beyond the entry-level offer.

No. OHIP (Oracle Hospitality Integration Platform) is available only through a single pay-as-you-go subscription model. At this time, there are no free tiers or alternative subscription options available.

As a partner, I would like the customer to pay for the API calls. Is that possible?

No. The owner of the application key is solely responsible for all API-related costs. Any commercial or financial arrangements between you and your customer are independent of Oracle.

As a partner, you are billed for API usage under the pay-as-you-go model described above. To monitor and review usage, you can access detailed analytics for each API call in the Analytics tab of your Partner Developer Portal.

When I receive the invoice, it shows a single line with accumulated costs. Is it possible to have these costs separated by chain or by hotel so that I can invoice the customer accordingly?

No. The invoice is generated through Oracle Cloud Infrastructure (OCI) and is therefore presented as accumulated costs, not separated by chain or hotel.

If you wish to view the number of API calls made by each chain, application, or hotel, you can do so in your Partner Developer Portal. Navigate to the Analytics tab where you can apply filters to view detailed usage statistics by entity.

Compliance

Where can I obtain Oracle Cloud PCI compliance attestations?

Refer to the Overview of Compliance Documents (oracle.com) page.

Connecting to a Customer

How can a partner connect to an OPERA Cloud property?

See the Partners Moving to Production topic for details.

How can I verify that an integration user was created correctly?

  1. Find the email you received when the hotel approved your integration user. This includes a URL for the Shared Security Domain identity server. Go to this URL.

  2. Log in using your integration username and password.

  3. Go to the My Access tab.

  4. Verify you have the <Tenant>-WSACCESS role.

If you have the WSACCESS role, then the integration user is correctly set up and has been approved by the environment owner.

My integration suddenly stopped working!

First, check that your credentials are correct. Integration Users can be checked by logging in to the Shared Security Domain and clicking the My Access tab.

If this is a production integration and there has been a major incident with your integration, Oracle Hospitality will contact you using the contact details listed on the application in the Developer Portal. If you do not respond, Oracle Hospitality will disable your integration. If you have missed this communication and your integration has stopped working, reach out to Oracle Hospitality via a Service Request to request details of what changes must be made before the integration will be reenabled. We will work with you to reenable your integration once the issue has been resolved.

If Oracle Hospitality has not contacted you about your production integration, then reach out to the environment owner and ask the owner to reset your integration user password. If the environment is an OPERA Cloud Identity Manager environment, log in to the Developer Portal and reset the clientSecret from the Environments tab.

Eligibility

What are the minimum requirements for a partner to call production OPERA Cloud environments?

  1. Your solution must be posted in the Oracle Hospitality Cloud Marketplace (listed under the OHIP product category).

    Note:

    A current Oracle Partner Network Membership (that is, base member, Level 0) is required to post a solution on the Marketplace.

    Note that this level is “zero” and not the uppercase letter O.

  2. Once your application is listed in the marketplace in the OHIP product category, email your listing ID to hospitality-integrations_ww@oracle.com and Oracle will grant you access to call production OPERA Cloud Environments.

  3. Create a new application by selecting Production at step 7 in Registering an Application.

  4. Create an integration user within the customer’s production tenancy and ensure the customer chain administrator has approved your user.

  5. Follow the procedure in Adding an Environment and enter the user name of the integration user.

How can a customer confirm if their subscription is to OPERA Cloud Foundation?

If there is a customer employee at the hotel who is familiar with the hotel’s OPERA contract, they can confirm this by reviewing their active subscriptions. Alternatively, the hotel can contact their Account Manager to verify this.

What are the minimum requirements for the streaming API?

For the streaming API, a hotel must be running OPERA Cloud Foundation version 22.3.0.1 or beyond. To get started, customers must engage with Oracle Professional Services.

How do I know if a customer is eligible to use OHIP?

We recommend partners check the following to ensure a smooth production move:

  • The customer must be running OPERA Cloud and have an active subscription for OPERA Cloud Foundation or OPERA Cloud Central.

Note:

OHIP is only available for OPERA Cloud Foundation and OPERA Cloud Central customers at this point.

Events

How long will OHIP retain events?

When using the streaming API, OHIP retains messages for 7 days; therefore, messages sent in those 7 days can be replayed (see Replaying Messages for more information). Messages not consumed within 7 days are lost and cannot be replayed.

When using the polling API, events are retained for 48 hour, but events cannot be replayed via the polling API.

How frequently should I connect to consume events?

It is recommended to keep the WebSocket connected, but depending on use case, this may be neither practical nor needed. However, connecting at least every few days ensures no messages will be lost.

There is no guarantee that a subscription to consume events will remain in place if the application fails to consume the subscribed events for 2 weeks.

What do the terms WebSocket and GraphQL mean?

To learn more, read our blog posts at https://blogs.oracle.com/hospitality/post/ohip-introduces-state-of-the-art-streaming-api-and-rich-analytics and https://blogs.oracle.com/hospitality/post/ohip-streaming-api-understanding-our-strategy.

Is the polling API for fetching business events going away?

No, for some use cases it is the right fit, so it will be available alongside the streaming API.

How many events can I consume at once?

With the polling API, a maximum of 20 events can be retrieved in one API call. The streaming API makes events available as soon as they occur, so there is no maximum number of events.

Will streaming affect throttling?

Only inbound API calls to OPERA Cloud are throttled; events produced from OPERA Cloud are not.

The events tab is not appearing in the application window. What am I missing?

You must have at least one OPERA Cloud environment with streaming enabled added to your Environments tab. You can identify if streaming is enabled for an environment by looking for the Streaming Enabled flag on the environment’s card (located under the Environments tab).

Is it possible to clear the backlog of events for my application?

No option is currently available to clear the backlog of events, and you must continue to process those events. Alternatively, you can create a new application and delete the old one if it is not required.

Onboarding

Do we need to sign an agreement to work with OHIP as an integration partner?

No, you must purchase Oracle Hospitality Integration Cloud Service from the Oracle Shop, but there is no further agreement required.

Is there a sandbox provided for testing?

As a customer, we recommend developing and testing in your UAT environment. For more information, see the Quick Start Guide for customers.

Integration partners have access to a sandbox environment. For more information, see the Quick Start Guide for partners.

When selecting the self-registration page, I do not see a Purchase button when choosing my country. It states that an offline order should be raised. How can I do that?

Please email hospitality-integrations_ww@oracle.com with your company details and a brief description of the integration you are developing. Oracle will initiate the offline order process.

These requests are typically processed in batches and might take a few weeks to complete.

I am developing an application for a customer, and it will be used exclusively by that customer. Do I need to purchase or register for OHIP?

No. In this case, you should contact your customer and request access to their Customer Developer Portal. From there, you can obtain the necessary credentials to access their Non-Production environment for development and testing.

Please note that customers maintain separate Developer Portals for Non-Production and Production environments.

I already have an Oracle Account that I use for other Oracle products. Can I use the same account for OHIP?

Yes, you can use the same Oracle Account. However, please note that your Oracle Account (typically your email address) and your Oracle Cloud Account are two separate entities.

You can purchase an OHIP subscription through the Oracle Shop using your existing Oracle Account. Once your order is completed, you will be prompted to create a Cloud Account, which generates a unique identifier (Cloud Account name or code) visible to customers within their portal.

As a customer, my third-party vendor is requesting credentials, such as the client ID, client secret, and application key. What should I do?

Third-party vendors must register for OHIP either through the Oracle Shop or by submitting an offline order. Once their registration is complete, they gain access to the Partner Developer Portal, which allows them to onboard their customers.

After the customer onboarding process is completed, the corresponding environment is added, enabling the vendor to retrieve the necessary credentials—such as the Client ID, Client Secret, and Application Key (available under the Applications tab)—to make API calls.

Customers should not share credentials from their Customer Developer Portal with third-party vendors.

My third-party vendor has requested the following information: Enterprise ID, Chain Code, Hotel ID, Region, and SSD Identity Manager URL. Should I provide these details?

Yes, you can share this information. It does not contain any Personally Identifiable Information (PII) and is required to support the onboarding of your customer environment within the Partner Developer Portal.

OPN and Marketplace

Is a validation or certification needed for OHIP?

A review is optional. By default, OHIP is intended to offer a self-service experience that enables developers to bring their solutions to life without the need for a formal validation. If you would like to request an Oracle Hospitality review, please email hospitality-integrations_ww@oracle.com.

How do I add my application to the Cloud Marketplace?

Click the link below and follow the instructions on the page:

https://cloudmarketplace.oracle.com/marketplace/en_US/partnerLandingPage

Where can I find information for joining the Oracle Partner Network (OPN)?

To join the Oracle Partner Network (OPN), follow the steps here: https://www.oracle.com/middleeast/partnernetwork/program/join/

Note:

Please note that the minimum level required for OHIP is the OPN Member Level.

Can we use the Oracle logo in our marketing materials?

No. The Oracle logo and other brand assets may not be used unless your company is officially part of an Oracle program, such as the Oracle PartnerNetwork (OPN), which explicitly grants logo usage rights.

While your products or services may integrate with Oracle technologies, this does not grant permission to display or reproduce Oracle's logos or trademarks.

You may, however, make factual statements such as:
  • "Integrates with Oracle Cloud"
  • "Compatible with Oracle Database"

If official co-branding or logo use is desired, your company must join the Oracle PartnerNetwork (OPN). Once you have joined OPN and listed your product on the Oracle Marketplace, the Integrations Team will provide guidance regarding marketing materials.

If you have not yet received assistance, please contact hospitality-integrations_ww@oracle.com.