3 Features and Updates

This chapter describes the features and updates contained in this release:

• Oracle Hospitality Integration Platform Developer Portal
  
• Technical Overview
  
• Released APIs
  
• Early Adopter API Program
  
• Billing
  

Oracle Hospitality Integration Platform Developer Portal

The Oracle Hospitality Integration Platform’s developer portal (developer portal) is used by application developers to browse and subscribe to APIs and get the necessary information to invoke them.

Developers can use the developer portal to:

• Interactively search for available published Oracle Hospitality Integration Cloud Service APIs (Hospitality APIs).

• Discover which Hospitality API resources are available using the embedded Oracle Apiary API Documentation.

  • View the long-form description of the Hospitality APIs.

  • Discover the request and response schema along with example responses.

  • Interact with Oracle Apiary’s mock and debugging servers.

• Register Applications to access application keys used to access both production and non production environments. You can register new applications from the Applications page.

• Manage your applications:

  • Edit applications and their contact details.

  • Show/hide the application key.

  • Re-issue application keys.

  • View Hospitality APIs subscribed to the application.

• View your Gateway information and ability to copy the gateway URL.

Technical Overview

The Oracle Hospitality Integration Platform (OHIP) is a Cloud Native solution architected from the ground up to meet the demands that our hospitality customers and partners are facing today in this digital age. The entire platform runs in Oracle Cloud Infrastructure (OCI), most specifically in Kubernetes, as fully stateless and independently deployable microservices. This modern architecture enables OHIP and its key components, such as the Developer Portal and API Gateways (the runtime component responsible for providing secure and rapid access to our Hospitality APIs), to be highly scalable and to securely handle high levels of throughput.

In addition, OHIP leverages a 3rd generation API Platform, namely the Oracle API Platform Cloud Service and Apiary, along with many other Oracle Cloud services, in order to deliver a rich and responsive self-service developer experience end to end. The solution is modular and flexible, meaning that new features can be released on-demand without having to wait for long release cycles. The subsequent sections describe in more detail some of the main components of OHIP.

Released APIs

You can browse through the Hospitality APIs in the developer portal to review the available APIs.

Note:

APIs updated to OPERA Cloud Services 21.1

The version 1 (v.1) APIs available in the Oracle Hospitality Integration Platform includes all APIs new or updated in OPERA Cloud Services version 21.1; these are also backward compatible with OPERA Cloud Services version 20.2.

The following is the list of v.1 APIs that can be discovered. These are all documented in the developer portal and can be subscribed to, both for access to production and non production Oracle OPERA systems.

• OPERA Cloud Activity API: resources that expose Sales Activity functionality of OPERA Cloud. Activities provide an account management capability for overseeing daily tasks such as appointments, sales calls and contact follow-up. 9 operations are available to create, get, update, delete, and complete activities.

• OPERA Cloud Block API: caters for Business Block functionality in OPERA Cloud. A block is a group of rooms held for guests who are attending an event, meeting, or function. You can create blocks for family reunions, business conferences, weddings, and so on. You can also set aside rooms for the event (block).

• OPERA Cloud Block Reservation Asynchronous API: caters for Block Reservation asynchronous functionality in OPERA. In this release, 2 operations are available.

• OPERA Cloud Customer Relationship Management API: caters for Profile Management functionality of OPERA Cloud. There are different types of profiles in OPERA Cloud, including Guest, Company, Travel Agent, Source, Group, and Contact. A profile can store and display a wide range of information about the guest, company, travel agent, and so on. In this release, there are 6 operations.

• OPERA Cloud (Sales) Event Management API: the Events feature in OPERA Cloud is designed to manage any kind of catering activity. Events can be as simple as a one-hour reception or more complex, such as a three-day business meeting with meals, breaks, and specific meeting room with setup and resource requirements. Any group function can be an Event. 3 operations allow events to be retrieved.

• OPERA Cloud Front Desk Master Data Management API: resources that expose Master Data Configuration for Front Office Operations in OPERA Cloud. There are 61 operations available.

• OPERA Cloud Front Desk Operations Service: caters to Front Desk operations and statistics. Front Desk features some of the most commonly used operations in OPERA Cloud, such as managing guest arrivals, managing in-house guests, and managing guest departures. Some additional tasks you can complete from the Front Desk menu are room searches, room assignments, and quick check outs as well as opening folios, creating registration cards, setting wake up calls, and sending messages to guests. Three operations enable users to retrieve statistics on front office operations and on housekeeping operations and allow users to check in a reservation.

• OPERA Cloud Housekeeping Service API: resources that expose Housekeeping functionality of OPERA Cloud. Housekeeping enables scheduling of daily room cleaning, maintenance, and housekeeping staff activities. It provides information about room status, out of order/out of service rooms, and forecasting. 8 operations are available, which allow users to access a housekeeping overview - a summary of the status of all rooms - and another to update room status, set and unset rooms as out of service and/or out of order.

• OPERA Cloud Integration Processor API: resources that expose functionality to fetch Business Events generated in OPERA Cloud. 2 operations retrieve business events for one or multiple hotels.

• OPERA Cloud Inventory API: caters for Inventory functionality in OPERA Cloud. This includes sell limits for date ranges, viewing and updating the properties inventory, as well as item inventory (such as rollaways, microwaves, and so on.).

• OPERA Cloud Inventory Asynchronous API: caters for Inventory asynchronous functionality in OPERA. In this release, 4 operations are available.

• OPERA Cloud List of Values Management API: resources that expose List of Value (LOV) functionality of OPERA Cloud. A List of Values in OPERA Cloud can be configured by a property. Then by using this API, users can retrieve all configured codes. For example, Titles is a configurable LOV. A hotel can specify the titles they wish to use, and by fetching the LOV for title, codes that are configured for a property can be viewed. There are 449 operations available to retrieve various lists of values.

• OPERA Cloud Price Availability Rate API: Availability enables you to manage your room inventory by providing a detailed view of all available and sold rooms at a property. Some of the tasks you can perform include defining conditions for stay restrictions, setting room sell limits, and searching for and viewing room availability. One operation is available to allow users to retrieve reservation guarantees.

• OPERA Cloud Rate API: Rate Availability functionality in OPERA Cloud. Rate Management provides all the tools you need to effectively define and manage the rate structures for a property in OPERA Cloud. Some of the things you can do include creating and managing rate codes, rate classes, rate categories, display sets, rate strategies, as well as managing promotion groups and codes. 3 operations are available.

• OPERA Cloud Rate Plan Asynchronous API: caters for Rate Plan asynchronous functionality in OPERA. In this release, 4 operations are available.

• OPERA Cloud Reservation API: resources that expose Reservations related functionality of OPERA Cloud, such as creating and updating reservations. Reservations are a central feature of OPERA Cloud. As a key source of information, the reservation specifies a guest's arrival date, departure date, room type, rate, packages, and many other details. It is also a gateway to dozens of other functions that contribute to the guest's experience. 25 operations allow users to create, get, update, cancel and reinstate a reservation, link and unlink reservations, validate reservation changes, mark a reservation as pre-registered, and revert a pre-registration get external reservations, search for reservations, add and remove upsells to reservations.

• OAuth API: a single resource that can be used to obtain JWT tokens based on Resource Owner Password OAuth grant.

Early Adopter API Program

The Early Adopter API Program offers program members early access to newly released “version 0” APIs. In your Developer Portal, these APIs are in a separate Early Adopter section, and you can discover and subscribe to these APIs within your registered application.

In this release of Oracle Hospitality Integration Cloud Service, Oracle is elevating the benefits of the Early Adopter program. Members of the program benefit from the following:

• Early access to all 3K+ API operations released (also known as “version 0” APIs).

• Best endeavors assistance provided by Oracle Hospitality Integration Cloud Service product management.

• The ability to provide feedback that can potentially influence the product roadmap.

Note:

Please keep to in mind that some of the (v.0) API capabilities offered as part of the early adopter program may be less stable than Production APIs and can experience some difficulties. Furthermore, our aim is to avoid breaking changes in v.0 APIs, however we cannot guarantee full backward compatibility as we roll out patches to improve functionality and/or usability of our early adopter APIs.

Also note that the best endeavors assistance provided by product management as part of the program is not subject to service level agreements (SLAs); however, we do offer a premium (paid) service for partners and/or customers who desire dedicated support. Please contact [e-mail] if this is of interest.

As an early API adopter, we look forward to your active insight and feedback as we refine and improve these API capabilities together.

• Early Adopter APIs
  

Early Adopter APIs

The following APIs are available for customers or partners who join the Early Adopter APIs program:

• OPERA Cloud Accounts Receivables API: caters for Accounts Receivables functionality in OPERA Cloud. The OPERA Cloud Accounts Receivable module enables you to manage debtors’ accounts, invoices, and remittance.

• OPERA Cloud Activity API: caters for Sales Activity functionality in OPERA Cloud. Activities provide you with an account management tool for managing daily tasks such as appointments, sales calls, contact follow-up, and so on.

• OPERA Cloud Activity Management API: caters for Activity Configuration functionality in OPERA Cloud. In this module you can retrieve, create, update Activity configuration codes; for example create a new Activity Type.

• OPERA Cloud Block API: caters for Business Block functionality in OPERA Cloud. A block is a group of rooms held for guests who are attending an event, meeting, or function. You can create blocks for family reunions, business conferences, weddings, and so on. You can also set aside rooms for the event (block).

• OPERA Cloud Block Configuration API: caters for Business Block configuration functionality in OPERA Cloud.

• OPERA Cloud Cashiering API: caters for Cashiering related functionality in OPERA Cloud. Cashiering provides access to a guest folio, posting journals, receipt histories, currency calculations, credit card settlements, and check a guest out.

• OPERA Cloud Channel Configuration API: caters for Channel Management functionality in OPERA Cloud. Channel Management allows a property to configure and administer channels such as OTAs, and web channels, covering functionality such as channel configuration, availability, inventory and restrictions.

• OPERA Cloud Customer Management Service API: caters for Customer Management Service, such as Track-it items.

• OPERA Cloud Customer Relationship Management (CRM) API: caters for Customer Relationship Management (profile) functionality in OPERA Cloud. There are different types of profiles in OPERA Cloud, including Guest, Company, Travel Agent, Source, Group, and Contact profile types. A profile can store and display a wide range of information about the guest, company, travel agent etc., depending upon the type of profile. For example, a guest profile can store the guest name, address, contact information, details on billing, membership benefits, preferences and much more. All profiles in OPERA when created are assigned a ProfileID. This ID will be used throughout the CRM APIs.

• OPERA Cloud Customer Relationship Management (CRM) Master Data Management API: caters for Customer Relationship Management (profile) configuration as well as Membership Configuration.

• OPERA Cloud Data Value Mapping API: The Data Value Mapping module offers capability to convert OPERA Cloud values to an external system's values or vice versa.

• OPERA Cloud Enterprise Configuration API: caters for Enterprise related functionality in OPERA.

• OPERA Cloud Enterprise Room Configuration API: caters for Room Configuration functionality in OPERA Cloud.

• OPERA Cloud (Sales) Event Management API: caters for Event Management functionality in OPERA Cloud. The Events feature in OPERA Cloud is designed to manage any kind of catering activity. Events can be as simple as a one-hour reception or more complex, such as a three-day business meeting with meals, breaks, and specific meeting room with setup and resource requirements. Any group function can be an Event.

• OPERA Cloud Event Management Configuration API: caters for Configuration functionality for Event Management in OPERA.

• OPERA Cloud Export Master Data Management API: caters for managing export master data configuration.

• OPERA Cloud Front Desk Master Data Management API: caters for Master Data Configuration for Front Office Operations in OPERA Cloud.

• OPERA Cloud Front Desk Operations Service API: caters for Front Desk Operations and Front Desk Statistic functionality in OPERA Cloud. Front Desk features some of the most commonly used operations in OPERA Cloud, such as managing guest arrivals, managing in-house guests, and managing guest departures. Some additional tasks you can complete from the Front Desk menu are room searches, room assignments, and quick check outs as well as opening folios, creating registration cards, setting wake up calls, and sending messages to guests.

• OPERA Cloud Housekeeping Service API: caters for Housekeeping functionality in OPERA Cloud. Housekeeping enables you to schedule daily room cleaning, maintenance, and housekeeping staff activities. It provides information on room status, out of order/out of service rooms, and forecasting.

• OPERA Cloud Integration Configuration API: caters for managing master data configuration in a hotel.

• OPERA Cloud Integration Processor API: caters for getting Business Events generated in OPERA Cloud.

• OPERA Cloud Inventory API: caters for Inventory functionality in OPERA Cloud. This includes sell limits for date ranges, viewing and updating the properties inventory, as well as item inventory (such as rollaways, microwaves, and so on).

• OPERA Cloud Leisure Management API: caters for external Leisure Management functionality integrated with OPERA Cloud.

• OPERA Cloud Price Availability Rate API: caters for Price and Rate Availability functionality in OPERA Cloud. Availability enables you to manage your room inventory by providing a detailed view of all available and sold rooms at a property. Some of the tasks you can perform include defining conditions for stay restrictions, setting room sell limits, and searching for and viewing room availability.

• OPERA Cloud Rate API: caters for Rate Availability functionality in OPERA Cloud. Rate Management provides all the tools you need to effectively define and manage the rate structures for a property in OPERA Cloud. Some of the things you can do include creating and managing rate codes, rate classes, rate categories, display sets, rate strategies, as well as managing promotion groups and codes.

• OPERA Cloud Reservation API: caters for Reservation functionality in OPERA Cloud. OPERA Cloud Reservations provides a complete set of capabilities for creating and updating reservations. Reservations are a central feature of OPERA Cloud. As a key source of information, the reservation specifies a guest's arrival date, departure date, room type, rate, packages, and many other details. It is also a gateway to dozens of other functions that contribute to the guest's experience. All reservations in OPERA Cloud require a guest profile. You can create profiles while booking a reservation. If a profile already exists, you can look it up (using getProfiles in CRM module) and attach it to the reservation during the reservation booking process using the Profile ID.

• OPERA Cloud Reservation Master Data Management API: caters for Reservation Configuration in OPERA Cloud. In this module you can retrieve, create, modify or delete configuration related to Reservations, Blocks and Leisure Management.

• OPERA Cloud Xchange Interface API: caters for OPERA Xchange Interface related functionality.

Billing

You can view API usage and billing data through the Oracle Cloud Console.