Hotelplatform Documentations

# About HotelPlatform

Welcome to our documentation! We are dedicated to providing comprehensive information about the HotelPlatform. Here's a brief overview of what you can expect from our documentation:

  • Purpose: Our project aims to make it easier to work with different service providers and manage hotel operations efficiently through one common application programming interface. Find out more
  • Features: Explore the key features and functionalities of the HotelPlatform.
  • Contributors: Meet the team behind HotelPlatform and learn about their roles.
  • How to Contribute: Interested in contributing? Find out how you can get involved.
  • License: Learn about the licensing terms and conditions for using HotelPlatform.
  • Contact Us: Have questions or feedback? Get in touch with us here

Feel free to reach out to us if you have any questions or feedback. Thank you for visiting our documentation! support@key-card.com

# Purpose

# Common API

The HotelPlatform project aims to provide a common API for different service providers to manage hotel operations efficiently. By using a unified interface, hotels can easily integrate with various systems and automate their processes.

Even though there are some approaches in the hospitality market to facilitate the integration between different systems, they are usually just recommendations and each vendor provides their own version. The HotelPlatform project aims to overcome these limitations by providing a flexible and extensible API that can be used by any service provider and providing the required services for it compared of just defining an API definition.

# Data pooling

The HotelPlatform project also aims to provide a data pooling service making it a single source of truth. This service can be used to share information about guests, reservations, and other relevant data, enabling hotels to collaborate and provide better services to their guests.

Most service providers limit api access to their own data, making it difficult for hotels to share information with other systems. The HotelPlatform project aims to provide a data pooling service that allows hotels to share information with other systems or share a common state.

# Ease of access

By providing the HotelPlatform API, we aim to make it easier for hotels and 3rd party providers to access and manage hotel data, regardless of the systems they use. This will help hotels streamline their operations, reduce manual work, and improve the overall guest experience. System integrators profit from a reduced integration effort and a common interface to connect to.

# Features

# HotelApi

Manage reservations, rooms, and guests with the HotelApi module. See the docs

# Access-Control

Control physical access to rooms and facilities with the Access-Control module.

# Configuration

One common place to configure all integrations and settings.

# Contributors

The system is inspired by the work of the Hotel Self-Check-in Terminals at Key & Card (opens new window).

# How to Contribute

We welcome contributions from the community! If you're interested in contributing to the HotelPlatform project, here are a few ways you can get involved:

  • Report Bugs: If you encounter any bugs or issues while using the HotelPlatform, please report them to us.
  • Request Features: Have an idea for a new feature or enhancement? Let us know!
  • Integrate with HotelPlatform: If you're a service provider or system integrator, consider integrating with the HotelPlatform API to provide better services to hotels.

# License and terms

The HotelPlatform API's are licensed under "The MIT License" LICENSE with these additional terms:

# Additional license terms

  1. Attribution: When using the HotelPlatform API definition in your projects, you must include proper attribution. This includes a clear mention of the original source and a backlink to the original documentation.

  2. Backlink Requirement: You must provide a backlink to our documentation in any distributed or published version of your API. This backlink should point to https://documenation.hotelplatform.io (opens new window) or https://hotelplatform.io (opens new window) and be prominently displayed in your API documentation or README file.

  3. Notification: While not mandatory, we would appreciate if you could notify us when you adopt or distribute the API with our OpenAPI definition. You can contact us at here.

By using the HotelPlatform OpenAPI definition, you agree to these additional terms.

# Contact Us

You can reach out to us by:

email: support@key-card.com
phone: +41 81 511 24 77

# Impress

Thomas Liebrand
c/o Key & Card AG
Neudorf 15
9466 Sennwald
Switzerland