Required Tools and Software

GitHub Repository: Access the Oracle Hospitality REST API specifications and accompanying Postman Collections.

Postman: Utilize the Postman Collections available in the GitHub repository to test and understand the API endpoints. A Postman account is required to fork and run this collection.

GraphiQL: Employ this interactive in-browser GraphQL integrated development environment to visualize and test the Streaming API. See Connecting to the Streaming API via GraphiQL.

Node.js Reference Implementation: Refer to the sample GraphQL Subscriptions client for OHIP's Streaming API, which provides a practical example of client implementation.

  • This example is especially helpful if you have previously worked with polling and HTTP requests but are new to long-lived WebSocket connections. Refer to the code and comments to see how the entire connection and subscription cycle works.
  • This example demonstrates the precise handshake, authentication mechanism, and subscription workflow required by OHIP (not always standard for Apollo/Relay clients).