[{"data":1,"prerenderedAt":175},["ShallowReactive",2],{"cds-site:languages":3,"cds-site:style":5,"cds-site:globals":48,"cds-site:menu":54,"page-en-/about":152},[4],"en",{"id":6,"name":7,"template":8,"logo":9,"logoMark":10,"favicon":11,"values":12,"cssProperties":14},"style_docs","Documentation","@checkin247/template-docs","hotelplatform-logo","hotelplatform-mark","favicon",{"icon_background":13},"#0B1B33",{"--color-ink":13,"--color-deep":15,"--color-signal":16,"--color-signal-deep":17,"--color-signal-light":18,"--color-canvas":19,"--color-error":20,"--color-brand-50":19,"--color-brand-100":21,"--color-brand-200":22,"--color-brand-300":23,"--color-brand-400":24,"--color-brand-500":25,"--color-brand-600":26,"--color-brand-700":15,"--color-brand-800":27,"--color-brand-900":13,"--color-brand-950":28,"--color-neutral-50":29,"--color-neutral-100":30,"--color-neutral-200":31,"--color-neutral-300":32,"--color-neutral-400":33,"--color-neutral-500":34,"--color-neutral-600":35,"--color-neutral-700":36,"--color-neutral-800":37,"--color-neutral-900":38,"--color-neutral-950":13,"--color-primary":25,"--color-primary-hover":15,"--color-surface":39,"--color-background-default":19,"--color-background-dark":13,"--color-text-strong":38,"--color-text-dark":38,"--color-text-body":36,"--color-text-default":36,"--color-text-muted":40,"--color-text-on-dark":41,"--color-border":31,"--color-border-default":31,"--font-heading":42,"--font-body":43,"--font-mono":44,"--radius-control":45,"--radius-card":46,"--radius":45,"--container-content":47},"#14306E","#4FC3B0","#136558","#8FE0D2","#F6F9FC","#B4442F","#EAF0F9","#CBD9F0","#A3BCE4","#6389C8","#2A56A8","#204487","#0F2452","#071223","#F8FAFC","#F1F5FA","#E3E9F2","#CFD8E6","#A6B3C6","#8494AB","#6C7C93","#5A6A80","#3B4A61","#12233F","#FFFFFF","#5D6C82","#D5E1F2","\"Outfit\", ui-sans-serif, system-ui, sans-serif","\"IBM Plex Sans\", ui-sans-serif, system-ui, sans-serif","\"IBM Plex Mono\", ui-monospace, monospace","10px","16px","780px",{"id":49,"siteName":50,"copyright":51,"footerText":52,"defaultLanguage":4,"vimeo":53,"linkedin":53,"youtube":53,"github":53,"logo":53,"logoMark":53,"favicon":53,"ogImage":53},"site","HotelPlatform.io Documentation","© 2026 key-card / HotelPlatform","API documentation of the HotelPlatform.",null,[55,64,70,77,83,90,96,103,110,117,124,131,138,145],{"id":56,"label":57,"description":53,"icon":53,"trailing_icon":53,"href":58,"sort":59,"status":60,"parent_item":53,"target":53,"isCanonical":53,"translations":61,"to":53,"menu":62},"m_main_api","API Documentation","/api-reference",1,"published",[],{"position":63},"main",{"id":65,"label":66,"description":53,"icon":53,"trailing_icon":53,"href":67,"sort":59,"status":60,"parent_item":56,"target":53,"isCanonical":53,"translations":68,"to":53,"menu":69},"m_main_api_AccessControl","AccessControl","/api-reference/AccessControl/latest",[],{"position":63},{"id":71,"label":72,"description":53,"icon":53,"trailing_icon":53,"href":73,"sort":74,"status":60,"parent_item":56,"target":53,"isCanonical":53,"translations":75,"to":53,"menu":76},"m_main_api_Configuration","Configuration","/api-reference/Configuration/latest",2,[],{"position":63},{"id":78,"label":79,"description":53,"icon":53,"trailing_icon":53,"href":80,"sort":74,"status":60,"parent_item":53,"target":53,"isCanonical":53,"translations":81,"to":53,"menu":82},"m_main_guide","Guide","/guide",[],{"position":63},{"id":84,"label":85,"description":53,"icon":53,"trailing_icon":53,"href":86,"sort":87,"status":60,"parent_item":56,"target":53,"isCanonical":53,"translations":88,"to":53,"menu":89},"m_main_api_HotelApi","HotelApi","/api-reference/HotelApi/latest",3,[],{"position":63},{"id":91,"label":92,"description":53,"icon":53,"trailing_icon":53,"href":93,"sort":87,"status":60,"parent_item":53,"target":53,"isCanonical":53,"translations":94,"to":53,"menu":95},"m_main_about","About","/about",[],{"position":63},{"id":97,"label":98,"description":53,"icon":53,"trailing_icon":53,"href":80,"sort":99,"status":60,"parent_item":53,"target":53,"isCanonical":53,"translations":100,"to":53,"menu":101},"m_sb_overview","Overview",4,[],{"position":102},"sidebar",{"id":104,"label":105,"description":53,"icon":53,"trailing_icon":53,"href":106,"sort":107,"status":60,"parent_item":53,"target":53,"isCanonical":53,"translations":108,"to":53,"menu":109},"m_sb_introduction","Introduction","/guide/introduction",5,[],{"position":102},{"id":111,"label":112,"description":53,"icon":53,"trailing_icon":53,"href":113,"sort":114,"status":60,"parent_item":53,"target":53,"isCanonical":53,"translations":115,"to":53,"menu":116},"m_sb_getting_started","Getting started","/guide/getting-started",6,[],{"position":102},{"id":118,"label":119,"description":53,"icon":53,"trailing_icon":53,"href":120,"sort":121,"status":60,"parent_item":53,"target":53,"isCanonical":53,"translations":122,"to":53,"menu":123},"m_sb_pagination","Pagination & Filtering","/guide/pagination-and-filtering",7,[],{"position":102},{"id":125,"label":126,"description":53,"icon":53,"trailing_icon":53,"href":127,"sort":128,"status":60,"parent_item":53,"target":53,"isCanonical":53,"translations":129,"to":53,"menu":130},"m_sb_changelogs","Changelogs","/guide/changelogs",12,[],{"position":102},{"id":132,"label":133,"description":53,"icon":53,"trailing_icon":53,"href":134,"sort":135,"status":60,"parent_item":125,"target":53,"isCanonical":53,"translations":136,"to":53,"menu":137},"m_sb_changelog_AccessControl","AccessControl Changelog","/guide/changelogs/AccessControl",13,[],{"position":102},{"id":139,"label":140,"description":53,"icon":53,"trailing_icon":53,"href":141,"sort":142,"status":60,"parent_item":125,"target":53,"isCanonical":53,"translations":143,"to":53,"menu":144},"m_sb_changelog_Configuration","Configuration Changelog","/guide/changelogs/Configuration",14,[],{"position":102},{"id":146,"label":147,"description":53,"icon":53,"trailing_icon":53,"href":148,"sort":149,"status":60,"parent_item":125,"target":53,"isCanonical":53,"translations":150,"to":53,"menu":151},"m_sb_changelog_HotelApi","HotelApi Changelog","/guide/changelogs/HotelApi",15,[],{"position":102},{"id":153,"slug":154,"title":155,"description":156,"blocks":157,"contentBlocks":168,"seo":174},"p_about","about","About HotelPlatform","Who builds the HotelPlatform, and the terms its APIs are offered under.",[158],{"id":159,"type":160,"title":53,"subtitle":53,"content":161,"image":53,"ctaText":53,"ctaUrl":53,"module":162,"alignment":53,"ratio":53,"colorScheme":163,"settings":164,"items":165,"texts":166},"b_about","markdown","\u003Ch1>About HotelPlatform\u003C/h1>\n\u003Cp>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:\u003C/p>\n\u003Cul>\n\u003Cli>\u003Cstrong>Purpose\u003C/strong>: Our project aims to make it easier to work with different service providers and manage hotel operations efficiently through one common application programming interface. \u003Ca href=\"#purpose\">Find out more\u003C/a>\u003C/li>\n\u003Cli>\u003Cstrong>Features\u003C/strong>: Explore the key features and functionalities of the \u003Ca href=\"#features\">HotelPlatform\u003C/a>.\u003C/li>\n\u003Cli>\u003Cstrong>Contributors\u003C/strong>: Meet the team behind \u003Ca href=\"#contributors\">HotelPlatform\u003C/a> and learn about their roles.\u003C/li>\n\u003Cli>\u003Cstrong>How to Contribute\u003C/strong>: Interested in contributing? Find out \u003Ca href=\"#how-to-contribute\">how you can get involved\u003C/a>.\u003C/li>\n\u003Cli>\u003Cstrong>License\u003C/strong>: Learn about the licensing terms and conditions for using \u003Ca href=\"#license-and-terms\">HotelPlatform\u003C/a>.\u003C/li>\n\u003Cli>\u003Cstrong>Contact Us\u003C/strong>: Have questions or feedback? Get in touch with us \u003Ca href=\"#contact-us\">here\u003C/a>\u003C/li>\n\u003C/ul>\n\u003Cp>Feel free to reach out to us if you have any questions or feedback. Thank you for visiting our documentation!\n\u003Ca href=\"mailto:support@key-card.com\">support@key-card.com\u003C/a>\u003C/p>\n\u003Ch2 id=\"purpose\" tabindex=\"-1\">Purpose\u003C/h2>\n\u003Ch3 id=\"common-api\" tabindex=\"-1\">Common API\u003C/h3>\n\u003Cp>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.\u003C/p>\n\u003Cp>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.\u003C/p>\n\u003Ch3 id=\"data-pooling\" tabindex=\"-1\">Data pooling\u003C/h3>\n\u003Cp>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.\u003C/p>\n\u003Cp>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.\u003C/p>\n\u003Ch3 id=\"ease-of-access\" tabindex=\"-1\">Ease of access\u003C/h3>\n\u003Cp>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.\u003C/p>\n\u003Ch2 id=\"features\" tabindex=\"-1\">Features\u003C/h2>\n\u003Ch3 id=\"hotelapi\" tabindex=\"-1\">HotelApi\u003C/h3>\n\u003Cp>Manage reservations, rooms, and guests with the HotelApi module.\n\u003Ca href=\"/api-reference/HotelApi/latest\">See the docs\u003C/a>\u003C/p>\n\u003Ch3 id=\"access-control\" tabindex=\"-1\">Access-Control\u003C/h3>\n\u003Cp>Control physical access to rooms and facilities with the Access-Control module.\u003C/p>\n\u003Ch3 id=\"configuration\" tabindex=\"-1\">Configuration\u003C/h3>\n\u003Cp>One common place to configure all integrations and settings.\u003C/p>\n\u003Ch2 id=\"contributors\" tabindex=\"-1\">Contributors\u003C/h2>\n\u003Cp>The system is inspired by the work of the Hotel Self-Check-in Terminals at \u003Ca href=\"https://key-card.com\">Key & Card\u003C/a>.\u003C/p>\n\u003Ch2 id=\"how-to-contribute\" tabindex=\"-1\">How to Contribute\u003C/h2>\n\u003Cp>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:\u003C/p>\n\u003Cul>\n\u003Cli>\u003Cstrong>Report Bugs\u003C/strong>: If you encounter any bugs or issues while using the HotelPlatform, please report them to us.\u003C/li>\n\u003Cli>\u003Cstrong>Request Features\u003C/strong>: Have an idea for a new feature or enhancement? Let us know!\u003C/li>\n\u003Cli>\u003Cstrong>Integrate with HotelPlatform\u003C/strong>: If you're a service provider or system integrator, consider integrating with the HotelPlatform API to provide better services to hotels.\u003C/li>\n\u003C/ul>\n\u003Ch2 id=\"license-and-terms\" tabindex=\"-1\">License and terms\u003C/h2>\n\u003Cp>The HotelPlatform API's are licensed under "The MIT License" \u003Ca href=\"/about/license\">LICENSE\u003C/a> with these additional terms:\u003C/p>\n\u003Ch3 id=\"additional-license-terms\" tabindex=\"-1\">Additional license terms\u003C/h3>\n\u003Col>\n\u003Cli>\n\u003Cp>\u003Cstrong>Attribution\u003C/strong>: 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.\u003C/p>\n\u003C/li>\n\u003Cli>\n\u003Cp>\u003Cstrong>Backlink Requirement\u003C/strong>: You must provide a backlink to our documentation in any distributed or published version of your API. This backlink should point to \u003Ca href=\"https://documenation.hotelplatform.io\">https://documenation.hotelplatform.io\u003C/a> or \u003Ca href=\"https://hotelplatform.io\">https://hotelplatform.io\u003C/a> and be prominently displayed in your API documentation or README file.\u003C/p>\n\u003C/li>\n\u003Cli>\n\u003Cp>\u003Cstrong>Notification\u003C/strong>: 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 \u003Ca href=\"#contact-us\">here\u003C/a>.\u003C/p>\n\u003C/li>\n\u003C/ol>\n\u003Cp>By using the HotelPlatform OpenAPI definition, you agree to these additional terms.\u003C/p>\n\u003Ch2 id=\"contact-us\" tabindex=\"-1\">Contact Us\u003C/h2>\n\u003Cp>You can reach out to us by:\u003C/p>\n\u003Cp>email: \u003Ca href=\"mailto:support@key-card.com\">support@key-card.com\u003C/a>\u003Cbr>\nphone: +41 81 511 24 77\u003C/p>\n\u003Ch2 id=\"impress\" tabindex=\"-1\">Impress\u003C/h2>\n\u003Cp>Thomas Liebrand\u003Cbr>\nc/o Key & Card AG\u003Cbr>\nNeudorf 15\u003Cbr>\n9466 Sennwald\u003Cbr>\nSwitzerland\u003C/p>\n",[],"default",{},[],{"body":167},"# About HotelPlatform\n\nWelcome 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:\n\n- **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](#purpose)\n- **Features**: Explore the key features and functionalities of the [HotelPlatform](#features).\n- **Contributors**: Meet the team behind [HotelPlatform](#contributors) and learn about their roles.\n- **How to Contribute**: Interested in contributing? Find out [how you can get involved](#how-to-contribute).\n- **License**: Learn about the licensing terms and conditions for using [HotelPlatform](#license-and-terms).\n- **Contact Us**: Have questions or feedback? Get in touch with us [here](#contact-us)\n\nFeel free to reach out to us if you have any questions or feedback. Thank you for visiting our documentation!\n\u003Ca href=\"mailto:support@key-card.com\">support@key-card.com\u003C/a>\n\n## Purpose\n### Common API\nThe 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.\n\nEven 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.\n\n### Data pooling\nThe 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.\n\nMost 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. \n\n### Ease of access \nBy 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.\n\n## Features\n\n### HotelApi\nManage reservations, rooms, and guests with the HotelApi module.\n[See the docs](/api-reference/HotelApi/latest)\n\n### Access-Control\nControl physical access to rooms and facilities with the Access-Control module.\n\n### Configuration\nOne common place to configure all integrations and settings.\n\n## Contributors\nThe system is inspired by the work of the Hotel Self-Check-in Terminals at [Key & Card](https://key-card.com).\n\n## How to Contribute\nWe welcome contributions from the community! If you're interested in contributing to the HotelPlatform project, here are a few ways you can get involved:\n- **Report Bugs**: If you encounter any bugs or issues while using the HotelPlatform, please report them to us.\n- **Request Features**: Have an idea for a new feature or enhancement? Let us know!\n- **Integrate with HotelPlatform**: If you're a service provider or system integrator, consider integrating with the HotelPlatform API to provide better services to hotels.\n\n## License and terms\nThe HotelPlatform API's are licensed under \"The MIT License\" [LICENSE](/about/license) with these additional terms:\n\n### Additional license terms\n1. **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.\n\n2. **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](https://documenation.hotelplatform.io) or [https://hotelplatform.io](https://hotelplatform.io) and be prominently displayed in your API documentation or README file.\n\n3. **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](#contact-us).\n\nBy using the HotelPlatform OpenAPI definition, you agree to these additional terms.\n\n## Contact Us\n\nYou can reach out to us by:\n\nemail: support@key-card.com  \nphone: +41 81 511 24 77\n\n## Impress\n\nThomas Liebrand  \nc/o Key & Card AG  \nNeudorf 15  \n9466 Sennwald  \nSwitzerland\n",[169],{"id":159,"type":160,"title":53,"subtitle":53,"content":161,"image":53,"ctaText":53,"ctaUrl":53,"module":170,"alignment":53,"ratio":53,"colorScheme":163,"settings":171,"items":172,"texts":173},[],{},[],{"body":167},{},1791403616610]