1 Getting Started

Both Oracle Hospitality Integration Cloud Service users and OPERA Cloud Foundation users are authorized to access the Oracle Hospitality Integration Platform, the Oracle Hospitality Developer Portal, and Oracle Hospitality APIs.

Getting Started for Partners (for Oracle Hospitality Integration Cloud Service Users)

There are two ways to onboard partners to the Oracle Hospitality Integration Cloud Service:
  • Oracle Store — You can onboard by purchasing the Oracle Hospitality Integration Cloud Service through the Oracle Store. Follow the procedure below to onboard through the Oracle store.

  • Partner Registration Cost Price Quote (CPQ) form— If you are unable to onboard through the Oracle Store, you can onboard by submitting the partner registration (CPQ) form. You can request this form through email by contacting hospitality_apis_ww_grp@oracle.com.

Oracle Store

To onboard through the Oracle Store:

Note:

You must have an Oracle account to proceed with the shopping cart checkout. To create a new Oracle account, go to the Oracle Store and click the New user? button and complete the form. After submitting the form, follow the instructions to check your email to verify your email address.

  1. Go to the Hospitality Integration Platform and click Shop now and then click Add to Cart.

    Alternatively, go directly to the Oracle Shop and click Add to Cart.

  2. Click your shopping cart to proceed to check out.

  3. Click Checkout.

  4. Follow the instructions to complete your account details, additional information, service information, billing information, and payment method and agree to the terms and conditions of the Cloud Service Agreement.

  5. Click Place Order.

To view and track your order, go to your Account Dashboard and click Orders.

After purchasing the Oracle Hospitality Integration Cloud Service, you will receive the following emails from either the Oracle Store or the CPQ process:
  • The first email is a confirmation of your order and contains the order number for reference.

  • A second email invites you to set up your Oracle Cloud Account. This email contains your order number.

    Follow the below steps to create your Oracle Cloud Account by clicking the Create Cloud Account link in the email and providing the following details.
    1. Cloud Account Name: A unique name for your Oracle Cloud Account.

    2. Email Address: Enter your email address. This is the email address to which the emails in steps 3 and 4 will be sent.

    3. Enter the email address of the cloud account admin and service admin for your services. This admin user can create other administrators or users.

  • A third email prompts you to confirm your Oracle Cloud Account.

  • A fourth email confirms that your setup is complete. This includes the Oracle Cloud Console URL to enable you to perform Cloud Admin tasks as well as a Service Instance URL to the Oracle Hospitality Developer Portal. This URL conforms to the following format:

    https://partner.hospitality-dev-portal.us-ashburn-1.ocs.oraclecloud.com/<Oracle Cloud Account Name>/ui/

Note:

If you have not received all the above emails within 24 hours of placing your order, please contact the Oracle customer service number referenced in the first email.

Quick Start for Partners (Using the Partner Sandbox)

This figure shows the flow of steps for using the partner sandbox.

  1. Onboard to OHIP via the Oracle Store.
  2. Add users to the Developer Portal.
  3. Sign in to the Developer Portal and register an application.
  4. Create an integration user.
  5. Obtain the credentials and gateway for the partner sandbox. The hotelId is SAND01.
  6. Call the APIs.
    If you need additional consulting to get you started, you can purchase it in groups of 2 hours. Visit the Oracle Store for more information.

Adding Developer Portal Users

Note:

To add or manage Portal users, you must have the Cloud Account Administrator or Service Administrator user role, your activated Oracle Cloud account, and your Oracle Cloud Console URL. For more information on how to onboard or provision an Oracle Cloud account, please refer to Getting Started for Partners.

The Account Administrator and Service Administrator users can add new users from the My Oracle Services screen in the Oracle Cloud Console.

Note:

Developer Portal users do not have access to call APIs.

Follow this process to create API users:

  1. Log in to your Oracle Cloud Account using your Oracle Cloud Console URL.
  2. Click Dashboard.
  3. On the Oracle Cloud Services screen, click Show.
  4. Click the My Profile icon and then click the My Home link.
  5. On the My Oracle Services screen, click the Identity Cloud account.
  6. In the Admin console, click the menu icon menu icon and then click Oracle Cloud Services.
  7. Click the Oracle Hospitality Developer Portal application.
  8. Click the assign user icon assign user icon.
  9. Click Application Roles.
  10. On the application developer screen, click Admin User.
  11. On the User Assignments screen, click Users in the left navigation panel.
  12. On the Users screen, click + Add.
    1. In the Add User window, enter the user details First Name, Last Name, and User Name/Email.
    2. Click Next to add more users or click Finish.
      The new user account is created.

Assigning Users to Roles

After adding a new user, you can assign the ApplicationDeveloper role to the user, which gives them access to the Oracle Hospitality Developer Portal.
  1. Click Oracle Cloud Services menu in the left navigation panel and then click Hospitality Developer Portal.
  2. Click Application Roles.
  3. Click Assign Users.
    Assign Users Screen
  4. On the Assign Users screen, select the user for the role assignment.
  5. Click OK.

Signing In to the Oracle Hospitality Developer Portal

Sign in to the Oracle Hospitality Developer Portal to create applications, discover available Oracle Hospitality APIs, and register Oracle Hospitality APIs to your applications.
  1. Open the Oracle Hospitality Developer Portal in a browser to the URL provided.
  2. Enter your username and password.
  3. Click Sign In.

    Note:

    Your account locks if you enter an incorrect username or password three times. For help getting back in to your account, click Can’t sign in and the follow instructions on the screen.

Signing Out of the Oracle Hospitality Developer Portal

You can sign out of the Oracle Hospitality Developer Portal using the User menu.
  1. On the Oracle Hospitality Developer Portal, click the user menu drop-down.
  2. Click Sign Out.
    Sign Out link in user menu

Changing Your Password

Note:

These instructions for changing your password apply to those who onboarded through the Oracle Hospitality Integration Cloud Service.

If you onboarded through Oracle Hospitality OPERA Cloud Foundation/OPERA Cloud Services, refer to Changing Your Password in the Onboarding Customers section.

To change your password:
  1. Sign in to the Oracle Hospitality Developer Portal.
  2. On the user drop down menu, click My Profile.
  3. Click the Change My Password tab:
    1. Enter your Old Password.
    2. Enter the New Password.
    3. After all password criteria are met, enter the new password to confirm, and then click Submit.

Getting Started for Hoteliers (for Oracle Hospitality Opera Cloud Foundation Users)

Oracle Hospitality OPERA Cloud Foundation includes access to the Oracle Hospitality Integration Platform.

Upon provisioning of or migration to Oracle Hospitality OPERA Cloud Foundation, you will receive an email advising you of the Oracle Hospitality Developer Portal URL.

For production OPERA environments, it will follow this URL format:
  • https://customer.hospitality-dev-portal.us-ashburn-1.ocs.oraclecloud.com/ashburn/ui/

    or

  • https://customer.hospitality-dev-portal.us-ashburn-1.ocs.oraclecloud.com/frankfurt/ui/

For non production OPERA environments, it will follow one of these URL formats:
  • https://customer.hospitality-dev-portal.us-ashburn-1.ocs.oraclecloud.com/ashburnuat/ui/

  • https://customer.hospitality-dev-portal.us-ashburn-1.ocs.oraclecloud.com/ashburnuat02/ui

  • https://customer.hospitality-dev-portal.us-ashburn-1.ocs.oraclecloud.com/frankfurtuat/ui/

Quick Start for Hoteliers (in UAT Environment)

Prerequisites

OPERA Cloud Foundation SKU
  • The hotel must purchase an OPERA Cloud Foundation SKU.

Note:

OHIP is not available for hotels using a legacy OPERA Cloud SKU.

Onboarded in OHIP
  • The chain containing properties that are on OPERA Cloud Foundation must be onboarded with OHIP.

Oracle Cloud Infrastructure
  • The onboarded chain and properties must be on Oracle Cloud Infrastructure (OCI) and NOT in a legacy data Centre.

Making API Calls

An OPERA Cloud chain administrator must create the DEVELOPERPORTALACCESS role via Oracle Identity Management (OIM) for both UAT and PRODUCTION.

  1. Assign the DEVELOPERPORTALACCESS role to all OPERA Cloud users requiring access to the OHIP Developer Portal. This will support Single-Sign On (SSO) with OPERA Cloud. See Getting Started for more information.
    • UAT: Refer to your Welcome email for this URL.
    • PROD : Refer to your Welcome email for this URL.
  2. Create a new integration user via Self Service using the UAT and PROD URLs. Refer to your Welcome email for these URLs. Once a request is submitted, the OPERA Cloud chain administrator must approve it. See Using the Oracle Hospitality APIs for more information.

  3. Access the Developer Portal for UAT or PROD (using the URLs from your Welcome email) and click the Environment tab.

  4. Click the environment card and to copy the client Id and secret. See Using the Oracle Hospitality APIs for more information.

  5. Register a new application in the Applications tab of the OHIP Developer Portal. When creating a new application, subscribe the application to all the APIs that appear. See Register and Manage Applications for more information.

  6. Enter the hotel ID from which you want to get data. This is not the same ID as the chain admin and should be the ID of a specific hotel.

    If you need to call early adopter (v0) APIs, send an email to hospitality_apis_ww_grp@oracle.com requesting to join the early adopter programme. You must reply to the email accepting the terms and conditions of the programme before access is provided.

Configuring Postman

  1. Obtain the postman collections via the following:

    • Cloning our github repo and then importing the collections / environment under the postman-collections folder.

    • Forking our public postman workspace directly.

  2. Set up a postman environment (one for UAT and one for PROD) with the previously obtained information plus the gateway URL:
    1. HostName: API gateway URLs for UAT and PROD. Refer to your Welcome email for these URLs.

    2. Username: Integration username previously obtained for UAT or PROD.

    3. Password: Integration password previously obtained for UAT or PROD.

    4. CLIENT_ID: Client ID previously obtained from the Developer Portal for UAT or PROD.

    5. CLIENT_SECRET: Client ID previously obtained from the Developer Portal for UAT or PRO.

    6. AppKey: The application key previously obtained .

    7. HotelId: Hotel ID against which you want to perform actions. For example, obtaining reservation data.

  3. Once all environments have been configured, select the Get OAuth Token collection and make a call.

    If everything is set up correctly, OHIP responds with a HTTP 200 OK response, which includes the OAuth token.

    Now you can try out other collections as required.

Creating the Developer Portal Access Role

This procedure is for a user with Chain Admin access in SSD-OIM to create an OHIP Developer Portal role for the corresponding OPERA instance. The role name is DEVELOPERPORTALACCESS.

When creating the role, ensure the role is assigned to the correct chain code.

Once the role is created, you can assign it to users so they can access the OHIP Developer Portal with the URLs specified in Getting Started for Hoteliers.

To add the DEVELOPERPORTALACCESS role

  1. Navigate to and log into the Oracle Identity Self Service portal.

    Note:

    The Oracle Identity Self Service URL is listed in the Welcome Letter received by your designated OPERA Property Administrator.

  2. Click the Manage button.

  3. Click the Roles tile and then click the Create link.

  4. Enter the following required information into the General Role section:
    1. Name. Enter the Organization name followed by DEVELOPERPORTALACCESS. For example, PARCHN01-DEVELOPERPORTALACCESS.

    2. Display Name. Reenter the same name as above.

      Note:

      The Owned By field will automatically populate based on who created the role.

  5. The Hierarchy, Access Policy, and Members steps are not required. Click the Next to arrive on the Organization step.

  6. Click the Add Organizations button.

  7. Search for the Organization name and click the Add Selected button to add the role.

  8. Click the Select button.

  9. Verify the DEVELOPERPORTALACCESS and then click Next.

  10. Verify the information you entered and then click the Finish button.

Adding Developer Portal Users

To access the Developer Portal, a hotel administrator assigns the DEVELOPERPORTALACCESS role to a chain org-level user in the Oracle Hospitality Shared Security Domain. For the steps to create this role, see Creating the Developer Portal Access Role.

Note:

Users assigned to this role must belong to the same organization specified in Creating the Developer Portal Access Role. Further, users must be chain org-level users to be granted the DEVELOPERPORTALACCESS role and to successfully access the Developer Portal.

Note:

Developer Portal users do not have access to call APIs.

For details on how to manage users in the Oracle Hospitality Shared Security Domain, refer to this My Oracle Support document:

Oracle Hospitality Shared Security Domain (SSD) for OPERA (Doc ID 2329730.1).

Signing In to the Oracle Hospitality Developer Portal

Sign in to the Oracle Hospitality Developer Portal to create applications, discover available Oracle Hospitality APIs, and register Oracle Hospitality APIs to your applications.
  1. Open the Oracle Hospitality Developer Portal in a browser to the URL provided.
  2. Enter your username and password.
  3. Click Sign In.

    Note:

    Your account locks if you enter an incorrect username or password three times. For help getting back in to your account, click Can’t sign in and the follow instructions on the screen.

Signing Out of the Oracle Hospitality Developer Portal

You can sign out of the Oracle Hospitality Developer Portal using the User menu.
  1. On the Oracle Hospitality Developer Portal, click the user menu drop-down.
  2. Click Sign Out.
    Sign Out link in user menu

Changing Your Password

Note:

These instructions for changing your password apply to those who onboarded through the Oracle Hospitality OPERA Cloud Foundation.

If you onboarded through the Oracle Hospitality Integration Cloud Service, refer to Changing Your Password in the Onboarding Partners - Oracle Hospitality Integration Cloud Service section.

To change your password:
  1. Sign in to the Oracle Hospitality Developer Portal.
  2. On the user drop down menu, click My Profile. A new browser tab opens for Oracle Identity Manager (OIM).
  3. Click the My Information tile.
  4. In the Change Password section, enter your Old Password, enter your New Password, and reenter your new password in the Confirm New Password field.
  5. Click Apply. After a password change, a confirmation message shows that your password was successfully updated.