Hospitality Pro

User guides and API documentation

Where to find the help of each screen, the guides by role and the technical documentation.

Help in the application

  • Help drawer on every screen — the help of the screen you are on
  • Help centre — every chapter, searchable, and the role guides as PDF in French, English and Spanish, once signed in
  • Sign in — to open the help centre

Integration guides

  • Live HR interface with HMS EE — hr-sync: organisation, employees, contracts, shifts, leave, punches and pay periods, both ways
  • Show HR content on CloudTV screens — posts, birthdays (first names), awards and open positions
  • Biometric terminals (ISAPI), SFTP folders, webhooks — each has its chapter in the help centre

API documentation

  • Public REST API — /api/v1 with API keys and scopes; Integrations › API documentation in the application
  • OpenAPI description — GET /api/v1/openapi.json
  • Webhooks — signed deliveries, described in the help chapter “Public API: keys, scopes and calls”