Overslaan en naar hoofdcontent gaan

Integreer met een restaurant via de Formitable REST API

Bijgewerkt

Werk je samen met een restaurant en wil je de gegevens ophalen, nieuwe reserveringen maken, bestaande reserveringen wijzigen, berichten verzenden of webhooks beheren?

Met de Formitable REST API kun je dat allemaal en nog veel meer. Volg de 7 stappen in dit artikel om een API verbinding op te zetten tussen jouw software en een Formitable restaurant.

Samenwerken? 🤝

Denk je dat de integratie die je wilt bouwen interessant is voor meer Formitable klanten? Neem dan contact op met onze Partnerships team via partnerships@formitable.com.

1. Verkrijg de 'API-sleutel' en 'restaurantUid' van een restaurant

De eerste stap om een integratie op te zetten met restaurants die Formitable gebruiken, is om toestemming te vragen en de API-sleutel te krijgen. Een restaurant is verantwoordelijk voor zijn eigen gegevens en beslist zelf of ze hun gegevens willen delen met software van derden.

Zorg ervoor dat je de integratie hebt besproken met de restaurant(s) waarmee je verbinding wilt maken. Als ze ermee instemmen om samen te werken, vraag ze dan om de API-sleutel met je te delen:

  1. Eerst moet de restauranteigenaar naar de Teampagina van het restaurant in Formitable navigeren.

  2. Selecteer een van de admin-accounts op de teampagina.

  3. Scroll omlaag naar Advanced.

  4. Schakel 'API user' in.

  5. Druk op 'Get API key'.

  6. Vraag de restauranteigenaar om de getoonde API-sleutel met jou te delen.

Bekijk ook deze GIF om de stappen hierboven te volgen:

Nadat je de API-sleutel hebt gekregen, moet je ook vragen naar de restaurauntUid van het restaurant. Dit is de unieke identificatiecode van een restaurant die nodig is om calls te maken op het restaurant. Vraag de restauranteigenaar voor de restaurantUid via Settings > Widgets > scroll omlaag naar Your Keys > Restaurant Key.

Of in het Nederlands: Instellingen > Widgets > scroll omlaag naar Je Sleutels > Restaurantsleutel.

Let op: door caching duurt het 5 minuten voordat een API user geactiveerd is.

2. Bespreek met het restaurant welke permissies je nodig hebt

Op dezelfde pagina waar je de API-sleutel vandaan haalt, kan de restauranteigenaar je toestemming geven om data in te zien, boekingen aan te passen, enz. Door op 'Manage permissions' (NL: 'Permissies beheren') te klikken onder de knop 'Get API key', kan een restauranteigenaar beslissen welke permissies te verlenen.

Mogelijke permissies zijn:

  • Beschikbaarheid en openingstijden controleren van je restaurant

  • Reserveringen bekijken

  • Nieuwe reserveringen maken en bestaande reserveringen wijzigen

  • Reserveringen annuleren

  • Informatie over je restaurant bekijken

  • Verkochte tickets, cadeaubonnen en takeaway-bestellingen bekijken

  • Informatie over je tickets, cadeaubonnen en takeaway-items bekijken

  • Recensies van je restaurant bekijken

  • Wijken van je restaurant bekijken

  • Tafels van je restaurant bekijken

  • Geïnstalleerde webhooks bekijken (een manier voor Formitable om gegevens naar de app te verzenden)

  • Nieuwe webhooks toevoegen en bestaande webhooks aanpassen

  • Webhooks verwijderen

  • Berichten naar gasten sturen

  • Berichten van je gasten bekijken

  • Restaurant instellingen aanpassen

  • Gastprofielen bekijken

  • Gastprofielen toevoegen en aanpassen

In het Engels:

  • Check availability and opening times of your restaurant

  • View your bookings

  • Create new bookings and modify existing bookings

  • Cancel bookings

  • View information about your restaurant

  • View sold tickets, gift vouchers and takeaway orders

  • View information about your tickets, gift vouchers and takeaway items

  • View reviews about your restaurant

  • View the areas of your restaurant

  • View the tables of your restaurant

  • View installed webhooks (a way for Formitable to send data to the app)

  • Add new webhooks and modify existing webhooks

  • Delete webhooks

  • Send messages to guests

  • View messages from guests

  • Modify your restaurant's settings

  • View guest profiles of your restaurant

  • Add/modify guest profiles of your restaurant

3. Lees de Formitable REST API documentatie

Lees vervolgens de Formitable REST API-documentatie zorgvuldig door. Hierin staat hoe je verbinding kunt maken met een restaurant, welke endpoints beschikbaar zijn en welke webhooks je kunt instellen.

Deze documentatie is ook geschreven voor het opzetten van een permanente integratie in onze App Store. Als je denkt dat je integratie mogelijk interessant is voor meer restaurants en je wilt praten over een mogelijke samenwerking, neem dan contact op met partnerships@formitable.com.

Houd er rekening mee dat er een significant aantal Formitable-restaurants geïnteresseerd moeten zijn in de integratie voordat we kunnen overwegen om deze toe te voegen aan de Formitable App Store.

4. Test de connectie met een restaurant

Start met het testen van de connectie door de informatie over het restaurant te verkrijgen via Get Restaurant in het Restaurant Endpoint:

GET https://api.formitable.com/api/v1.2/restaurants/{restaurantUid}
ApiKey: thisisyourtoken
Accept: application/json

Zie de Get Restaurant-call in de Restaurant Endpoint voor de juiste respons.

5. Bouw de integratie met de beschikbare endpoints en/of webhooks

Je bent nu klaar om te beginnen met het bouwen van je integratie. Als je technische assistentie nodig hebt, meer informatie nodig hebt over welke Endpoints die je kan gebruiken of advies wilt over het opzetten van je integratie, kun je ons bereiken via partnerships@formitable.com.

Om meer te weten over hoe Formitable werkt, is het advies om de volgende artikelen te lezen over het opzetten van tickets en beschikbaarheid. Op die manier heb je meer kennis over hoe een restaurant is opgebouwd in Formitable en zul je makkelijker je integratie kunnen bouwen:

6. Zorg dat je errors goed afhandelt.

Als je met het Booking Endpoint werkt om reserveringen voor een restaurant te maken, zorg er dan voor dat je zo bouwt dat fouten kunnen worden afgehandeld. Als een restaurant bijvoorbeeld vol is, krijg je een 400-foutmelding. Zorg ervoor dat jij of het restaurant op de hoogte is van het feit dat de integratie heeft geprobeerd een reservering te maken, maar dit is mislukt, om boze gasten aan de deur van het restaurant te voorkomen.

Je vindt de mogelijke Response Messages voor elke call in de API-documentatie.

7. Test je integratie

Het testen van je integratie betekent dat je test met echte data van een restaurant. En je maakt echte reserveringen in het restaurant. Bespreek met een restaurant hoe je dit het beste kan doen, zodat je tests niet in de weg zitten met de dagelijkse gang van zaken van het restaurant.

Je kunt bijvoorbeeld test-reserveringen ver in de toekomst maken en deze na het testen verwijderen. Of vraag een restaurant om een extra, nep-wijk te creëren waarin je kunt testen.

Als dit niet mogelijk is, neem dan contact met ons op via partnerships@formitable.com om een demo-restaurant op te zetten om in te testen.

Verwante artikelen