Oracle Hospitality API Documentation

The REST API specifications for Oracle Hospitality are provided as OAS 2.0 (OpenAPI Specification) files within this repository.

For a more human-readable version of these specifications, use the Oracle Hospitality Integration Platform website.

This repository provides the REST API specifications and Postman collections for Oracle Hospitality APIs.

• REST API Specifications: Located in the rest-api-specs directory.
• Postman Collections: Located in the postman-collection directory.

For high-level information regarding the integration platform, visit the Oracle Hospitality Integration Platform.

The repository provides Postman collections designed to demonstrate functional workflows for Oracle Hospitality APIs (e.g., digital check-in and checkout).

To use these collections effectively, you need three components:

1. Postman Collections: Contain various API call samples for specific functional workflows.
2. Postman Environment: Defines the main environment variables required to authenticate and execute requests against the Hospitality APIs.
3. Workflows Documentation: A detailed description of the different workflows supported within the collections.

You can access these collections directly via the online Postman workspace.

You can access and run the OPERA Cloud REST API collections directly in Postman. There are two primary collections available:

1. Property REST APIs by Module: Contains the individual API endpoints organized by functional module.
2. Property REST API Workflows: Contains pre-defined sequences of API calls to execute common business processes (see WORKFLOWS.md for details).

Important: Both collections require the oracle-hospitality Postman Environment to function correctly. Ensure you have imported the environment file before running the collections.

https://www.postman.com/hospitalityapis/oracle-hospitality-apis/collection/46029196-cbe581d9-46f5-4d35-8d85-919e23860d42/1-property-rest-apis-by-module/fork?origin=sidebar

The easiest way to start using the OPERA Cloud Postman collections is to fork them directly into your Postman workspace using the provided link. This will import the collection structure and allow you to begin making API calls immediately after configuring your environment variables.

https://www.postman.com/hospitalityapis/oracle-hospitality-apis/collection/46029196-53613a8c-53f4-4708-b94f-3df6071acccc/4-nor1-upgrade-rest-apis/fork?origin=tab

For complex business logic that requires multiple API calls in sequence, use the Property REST API Workflows collection. This collection is designed to automate common property management tasks through orchestrated API calls. Detailed explanations of how these workflows are structured can be found in the WORKFLOWS.md file within this directory.

https://www.postman.com/hospitalityapis/oracle-hospitality-apis/collection/15729853-706f9505-6067-42a9-a311-e35051554bfc/2-property-rest-api-workflows/fork?origin=tab

You can use Postman collections to interact with Oracle Hospitality OPERA Cloud Services. These collections allow you to test and explore the REST APIs for hotel management functionality.

To use these collections, you must first import the required environment file to ensure all variables (such as base URLs and authentication tokens) are correctly mapped across the requests.

Required Environment: ../oracle-hospitality.postman_environment.json

To test and interact with the R&A Data APIs, you can use the provided Postman collection.

1. Environment Setup: Ensure you have the oracle-hospitality Postman Environment configured. This environment contains the necessary variables for authentication and base URLs.
2. Import Collection: Use the 'Run in Postman' link to fork the collection directly into your Postman workspace.

https://www.postman.com/hospitalityapis/oracle-hospitality-apis/collection/cdv8usm/6-r-a-data-apis/fork?origin=sidebar