Skip to main content
SDK FAQs

In this article we will share with you details about SDK and how you can use it

Updated over a week ago

Can you provide a brief overview of the PMS-Chekin integration?

Yes. The integration involves implementing Chekin's Host SDK and Guest SDK into PMS’s platform. This integration helps in automating legal compliance tasks for property managers, such as police and statistics reporting and generating necessary documents.


What functionalities does the Host SDK cover?

The Host SDK includes:

  • Police Connection: Configuring and sending guest data to police authorities.

  • Statistics Connection: Sending data to national statistical institutes.

  • Document Generation: Creating and storing mandatory legal documents.

  • Property List View: Viewing and managing properties and their configurations.


What is the process for configuring the police connection?

To configure the police connection:

  1. Enter the required property information based on the country.

  2. Input the police portal login credentials (username, password, service key).

  3. Validate the credentials.

  4. Once validated, the system will automatically send guest data to the police.


How does the statistics connection work and how is it different from the police connection?

The statistics connection is similar to the police connection but is specific to national statistical requirements. It involves:

  • Selecting the region.

  • Entering credentials (username, password).

  • Validating the connection.

This is mandatory in some countries, like Italy, which requires both police and statistics reporting.


What are the document generation capabilities of the Host SDK?

The document generation feature allows hosts to create guestbooks and other required documents. Hosts can:

  • Select the date range and starting number for guestbooks.

  • Generate and store documents mandated by law.

  • Download these documents for record-keeping.


Can the Host SDK be customized in terms of design and functionality?

Yes, the Host SDK can be customized. While there are default settings, it allows:

  • Styling through a library of CSS components.

  • A white-label feature for more extensive customization (future implementation).

  • Modular setup, enabling the selection of specific functionalities to display.


How can bulk updates be handled for multiple properties with the same police account credentials?

While not common, bulk updates are being developed. This feature will allow:

  • Configuring multiple properties at once with the same credentials.

  • Applying the same settings across several units to streamline the process.


How can a Chekin account be created through PMS’s dashboard using the API?

To create a Chekin account via the API:

  1. Use the account creation API endpoint.

  2. Provide necessary details like email, password, and origin set to PMS.

  3. An API key will be returned for the new account.


Is there a need to manually create webhooks after account creation?

It depends on the integration approach:

  • If using Chekin's integration, webhooks for properties and reservations will be automatically created.

  • For more control, PMS can manage the import of properties and reservations and create webhooks as needed.


How are API keys managed for the Guest SDK and Host SDK?

API keys are user-specific:

  • Separate API keys are required for the Guest SDK and Host SDK.

  • These keys are created via API by setting the DNS, name, and type (guest app or dashboard).


Can specific listings be selected for export to Chekin?

With the current integration, all active listings are imported automatically. However, for more control, PMS can manage the property export process via API.


Is there any design flexibility in the Host SDK similar to the Guest SDK?

Yes, there is design flexibility in the Host SDK:

  • It includes a library of CSS components for styling.

  • Future plans include a white-label feature for extensive customization.


What are the steps to test the Host SDK in a staging environment?

To test the Host SDK:

  1. Access the staging URL provided in the documentation.

  2. Follow the quick start guide to create an account and obtain the API key.

  3. Implement and test the SDK functionalities in the staging environment.

Did this answer your question?