FAQ

HomeKnowledge BaseFAQ

Upgrading to API v3

103 views /  0 like /  / admin/

Quick Links:

API changelog

  • Base url changed to https://a.chekin.io/api/v3/
  • Authentication Tokens switched to JWT. Token refresh is required now.
  • Legals API was refactored to cover extra use cases, yet it’s flexible enough to be used in a very similar way than API v2 or API v1 as needed.
  • Online Check-in API was refactored and can be used together wil legals API or independently for data capture only. Guest form UI was redesigned for a better user experience.
  • Webhooks for Police, Statistics and Online Check-in were added.
  • OCR API capabilities were extended with minimal changes to read IDs with barcodes now.

Authentication
API v3 has a new endpoint to get the token: https://docs.chekin.io/#authentication.

The token expires in 1 hour and there is another endpoint to refresh it: https://docs.chekin.io/#token-refreshing

Legals
In v3 the Legals API was refactored making reservations the main entity, and different integration types are supported now:

  1. Simplified integration: You use a single endpoint, and manage reservations only. If you were using legals in API v2 (/tools/police/register/), this is possibly the easiest way to upgrade to v3. You will still send all the data in a single request, but using the new reservations endpoint. The data will be sent to legal authorities  at a fixed time of the day now. You can check the status later using polling or webhooks now.
  2. Full integration: You manage all the entities: houses, police accounts, stats accounts, reservations and guests, using multiple endpoints, keeping them in sync between your system and Check In. If you were using API v1, or you are looking a more complete and flexible integration, this is possibly your best choice.

Check full details on both integration types in this guide:
https://integrations.chekin.io/knowledgebase/chekin-legals-native-integration/

Online Check-in
The online check-in link is returned in reservation creation now, allowing you to send it to the guest into your own emails, or use it as you wish to capture guest data, as explained in this guide:
https://integrations.chekin.io/knowledgebase/online-chekin-native-integration/

The UX of the guest form was redesigned and the logo can be changed by yours from settings.

OCR
The endpoints and usage of OCR API v3 is the same as in API v2. Only the way to get the token has changed. Also, barcodes scan feature was added. This feature is enabled on-demand. Check the OCR integration guide for more details.

Related Articles