Skip to content
Last updated

Easy Integration Guide

We've made integrating with the BeMyGuest API as simple as possible. Just follow the steps below.

API Workflow

  1. Map data from the API by writing code manually or using our SDK.
  2. Become familiar with the BMG data structure.
  3. Map locations, categories, and other dictionaries from the /config endpoint.
  4. Map /products and /products/{uuid}.
  5. Map /products/{uuid}/product-types and /product-types/{uuid}. Product types are the items to be sold (SKUs).
  6. Integrate booking options (dynamic fields on product types).
  7. Integrate timeslots (dynamic fields on product types).
  8. Map calendar availability and the pricing matrix from /product-types/{uuid}/price-lists.
  9. Integrate dynamic pricing. Some product types may have different pricing per date.
  10. Cache data on your server and refresh it according to our recommendations.
  11. Before creating a booking for a selected product type, check the price and availability at /product-types/{uuid}/price-lists/{YYYY-MM-DD}.
  12. Create a test booking on the Demo environment via the /bookings endpoint.
  13. After collecting payment on your platform, confirm the booking via the /bookings/{uuid}/confirm endpoint.
  14. Download the PDF format vouchers to your platform via the /bookings/{uuid}/vouchers endpoint and distribute them to your customers.
  15. Do not share voucher URLs provided by the API. You need to be authorized to download them.
  16. Work with errors and their messages. While working with the API, you need to be able to handle errors returned by the endpoints flawlessly.
  17. When you are ready, take the Integration Test and submit the result to BMG Tech.
  18. Once you have passed the Integration Test, a BMG Account Manager will conduct UAT to ensure you can work with all possible product settings.
  19. Go live in production and start selling!
 
Next page