Skip to content
Introduction
/
Home
Last updated

Welcome

Overview of the PMS API Documentation

The PMS API serves as the bridge between Property Management Systems (PMS) and our centralised platform. This API facilitates seamless communication between hotel systems and our loyalty/membership program, enabling efficient check-ins, check-outs, and member validation. Designed with scalability and flexibility in mind, the PMS API is your go-to solution for integrating with various business units.

Key Features

  • Seamless Check-In/Check-Out: Automate stay confirmations and ensure accurate tracking of booking usage.
  • Robust Security: Tokenised workflows ensure secure and validated API calls.
  • Flexible Integration: Built to connect with a wide variety of PMS systems and other potential business units.
  • Real-Time Event Tracking: Stay updated on guest activity with instant data synchronisation.
  • Member Validation: Quickly verify a customer’s loyalty or membership status.

Why Use the PMS API?

  • Simplified Integration: With RESTful endpoints, clear documentation, and a sandbox environment, integrating with our API is a breeze.
  • Scalability: Handle multiple properties and large volumes of traffic with ease.
  • Enhanced Data Accuracy: Minimise human error with automated data flow between systems.
  • Future-Proof Design: The API is not tied to a specific business unit, ensuring compatibility with evolving business needs.

Getting Started

  1. Explore the API: Visit the API Reference for detailed endpoint documentation.
  2. Set Up Your Environment: Learn how to configure your development and production environments in our Setup Guide.
  3. Authenticate: Follow our Authentication Guide to start using the API. #4. Test in the Sandbox: Try out our Sandbox Environment to simulate real-world scenarios.

API Flow at a Glance

  1. Authenticate Member: Validate the customer’s loyalty card details.
  2. Check-In Guest: Record when a guest checks in to their property.
  3. Check-Out Guest: Confirm the guest’s check-out and close the stay record.
  4. Track and Sync: Monitor and synchronise stay data in real time.

Developer Resources

  • API Reference: Detailed descriptions of all endpoints, request/response formats, and error codes.
  • Authentication Guide: Learn how to securely authenticate with the API.
  • Support: Get in touch with our technical support team for any questions.

Need Help?

If you encounter any issues or have questions about integrating with the PMS API, our support team is here to help. Visit the Support Section or email us at support@roomex.com.

Let’s get started! 🚀

 
Next page