Roomability Guest API
  1. Getting Started
  • Getting Started
    • Introduction
    • Requirements
    • Authentication
    • Errors
    • Booking Flow
  • Reservation
    • Add
    • Availability
    • Cancel
    • Booking Ref
  • Country
    • Get Countries List
  • State
    • Get State List
  • RoomType
    • Get Room Types
    • Get Room Detail
  • Guest
    • Detail
  • Term
    • Detail
  • Privacy
    • Detail
  • Payment Method
    • Active List
  • Paystack
    • Verify
    • Initialize
  • Hotel
    • Detail
    • Hotel Rule
  • PayGateway
    • Detail
  • CancelPolicy
    • Detail
  • Get Branches Location
    GET
  • Phone Code List
    GET
  1. Getting Started

Authentication

The PMS API uses a key-based authentication. Every request must include a valid API key in the request header.

API Key Header#

All endpoints require the following header:
HeaderRequiredDescription
X-API-Key✅ YesYour hotel-specific Guest API key or Test key

Security Best Practices#

Never expose API keys in frontend code. All API calls should be made from your server backend, not directly from the browser or mobile app.
Store keys in environment variables. Do not hardcode API keys in source code or commit them to version control.
Use HTTPS at all times. All API endpoints are served over HTTPS. Never make requests over plain HTTP.

Modified at 2026-03-16 17:59:10
Previous
Requirements
Next
Errors
Built with