Registering an Application

Register new applications from the Applications page.

Note:

If you are developing or managing multiple solutions, Oracle recommends creating a separate application registration for each solution. This approach provides better isolation, monitoring, and lifecycle management than sharing a single application registration across multiple solutions.

1. In the Oracle Hospitality Developer Portal, click the Applications tab.
2. Click Register Application.
3. On the Register Details panel, enter the application name and an optional description.
4. Enter the Application Name that applies to your application.
5. Optionally, add a Description for the application.
6. Select the environment: Non Production or Production. An application can be either a non production application or a production application.

   • Non Production: By default, an application has access only to non production environments. A non production application may not access production environments, so to move from calling non production to calling production environments, you must create a new production application. To access production environments, please email your Oracle Partner Network (OPN) reference number to [e-mail].

   • Production: Production refers to Oracle Hospitality APIs that can access Oracle Hospitality systems such as a production Oracle Hospitality OPERA Cloud Services environment. A production application may not access non production environments.

7. If an application is a customer application linked to a Production environment, then you must enter a Business Justification for the new application and click to confirm the Oracle Terms & Conditions before the application can be created.
8. In the Contact Information section, enter your First Name, Last Name, and Email Address. Entering the Email Address, Phone Number, and Company Name is mandatory.
   The email address provided during application registration in Oracle Hospitality Integration Platform (OHIP) is utilized the following ways:

   • Deprecated API Notifications: When a Customer or Partner calls APIs that have been deprecated, OHIP sends weekly notifications to the email address provided.
   • Usage Alerts: Refer to Call Usage Alerts.
   • Major Incident Alerts: In the event of a major incident with your production integration, Oracle Hospitality will reach out to you using these contact details to inform you of the incident. Oracle Hospitality will temporarily work with you to disable the integration and determine what actions must be taken before the integration can be re-enabled. If you do not respond when Oracle Hospitality reaches out to you, Oracle Hospitality will disable your integration. Therefore, it is vital these contact details are monitored 24x7.
9. Click Next.
10. On the Subscriptions panel, edit and view the available Oracle Hospitality APIs to which you can subscribe with this application and then select the Subscribe check box.
    APIs include Hospitality Property (general property APIs), OAuth (needed for access), Hospitality Data APIs (R&A data), API Catalog Plan (OIC use), Hospitality Distribution, and OHIP Enterprise Analytics (Enterprise application use).

    Note:

    It can take up to 15 minutes after subscribing for the APIs to become available.

    Only subscribe to API Catalog if your application will be used for Oracle Integration Cloud (OIC) Hospitality Adaptor.

11. Click View API documentation to view the API documentation for the Oracle Hospitality APIs to which the application will be subscribed.
12. Click Register. The message Application Registered Successfully confirms the registration.
13. Your newly registered application appears at the top of the list on the Applications tab.

    Note:

    You can register up to 200 applications. You cannot register additional applications if you have reached the allowed limit. If you try to do so, the following error appears:

    Error: Cannot create your application as you have reached the maximum number of applications allowed.

Best Practices for Handling Multiple Applications

Partner applications and OPERA Cloud Central customer applications can connect to multiple environments. For example, a UAT application can connect to any number of UAT environments, and a production application can connect to any number of production environments.

The following guidelines explain when additional applications should be created. Oracle recommends using a small number of applications and using API responses to partition downstream systems, such as by chain.

Handle chain-specific logic in the consumer service not by duplicating applications. This keeps authentication overhead manageable, including keeping tokens fresh, keeping configuration centralized, and simplifies monitoring.

Use separate applications only if there's a clear need, such as:

• You offer two different integrations and customers can buy one or both.
• You offer an early adopter version of your product to select customers and a mainstream version of your product to everyone else.
• You have tried all other options for scaling your event consumption and now need to consume larger events from all connected environments in one stream and smaller events from all connected environments in another.

Avoid creating separate applications to:

• Segregate by chain. Instead, build this into your consuming service and if needed use your own logs. You can report by chain using OHIP Analytics even from the same application.
• Segregate by customer. You can report by enterpriseId in OHIP Analytics.

These approaches can increase your configuration, monitoring, debugging, and credential rotation costs.