BeMyGuest API Easy Integration

We've made it as simple as possible.

BeMyGuest API flow

API workflow

Just follow steps below.

  • Map data from API by writing code manually or using our SDK.
    • Become familiar with BMG data structure, key-values pairs are explained at Apiary.
    • Map locations, categories and other dictionaries from endpoint /config
    • Map /products
    • Map /product-types - items to be actually sold (SKU).
    • Integrate booking options - dynamic fields on product types.
    • Map pricing matrix from /product-types/{uuid}/price-lists
  • Cache data on your server and refresh it according to recommendations.
  • Register webhooks, BMG will call these endpoints when important events occurs.
  • Book on Demo server.
    • Before booking selected product type check price and availability at /product-types/{uuid}/price-lists/YYYY-MM-DD
    • After creating a booking and collecting payment on your end, confirm the booking at /bookings/{uuid}/confirm
  • Download vouchers.
    • You'll get webhook call 'vouchers_ready', also need to check status on your own /bookings/{uuid}
    • Do not share vouchers URLs provided by API. You need to be authorized to download.
  • Work with errors and their messeges.
    • While working with API you need to be able flawlessly work with errors described here.
  • Pass the BMG integration and UA tests to make sure you can work with all possible products settings.
    • Test is a list of task, mostly making bookings on selected products with different setup (timeslots, booking options, guests limits).
  • Go live production & sell!

Start getting familiar by requesting data from /config endpoint.