Naar de inhoud

WaW integreren in je platform

Bouw een koppeling die de boekingen en contacten van je klanten naar hun WaW-account stuurt.

Updated Bekijk als markdown

Deze gids is voor platformen waarvan de klanten ook in WaW werken. Je platform stuurt nieuwe en gewijzigde boekingen naar het WaW-account van de klant. Zo hoeft de klant een boeking nooit twee keer in te geven.

Hoe het in elkaar zit

  1. Een klant van jou heeft een WaW-account.
  2. De klant keurt je platform goed. WaW geeft je een klantsleutel voor dat account.
  3. Je bewaart de sleutel bij die klant in je platform.
  4. Telkens er bij jou een boeking of contact verandert, stuur je die wijziging met die sleutel naar WaW.

Stap 1: een klant koppelen

Dit doe je één keer per klant.

  1. De klant heeft een WaW-account met een actief abonnement of een proefperiode.
  2. De klant keurt de koppeling goed. Neem contact op met WaW om dit te starten. Een beheerder van het WaW-team van de klant moet goedkeuren.
  3. WaW bezorgt je een klantsleutel via een veilig kanaal. Eén sleutel hoort bij één klant en één omgeving.
  4. Je bewaart de sleutel op je server, gekoppeld aan die klant. Gebruik een geheimenkluis of een versleutelde kolom. Zet een sleutel nooit in een browser, een mobiele app, een URL of een log.

Een sleutel opent alleen het account van die ene klant. Je kunt er niet mee schrijven bij een andere klant. Lees Authenticatie.

Stap 2: bepalen wanneer je wat stuurt

De meeste koppelingen hebben vier momenten nodig:

Wat er op je platform gebeurt Wat je naar WaW stuurt
Er komt een nieuw contact bij Een contact aanmaken
Er komt een nieuwe boeking Een boeking aanmaken, met de WaW-ID van het contact als contact_id
Een boeking of klant verandert Een boeking bijwerken of Een contact bijwerken, met alleen de gewijzigde velden
Een boeking wordt geannuleerd Werk de boeking bij naar status: "lost" met een lost_reason

Maak altijd eerst het contact aan, en daarna de boeking. De boeking heeft de WaW-ID van het contact nodig.

Via de API kun je geen records verwijderen. Een geannuleerde boeking blijft in WaW staan met de status lost, zodat de klant de geschiedenis behoudt.

Stap 3: ID’s bijhouden

Elk record heeft twee ID’s:

ID Wie kiest het Waarvoor dient het
external_id Jij Je eigen ID, zoals je boekingsnummer. Stuur het mee wanneer je een record aanmaakt.
id WaW Komt terug wanneer je een record aanmaakt. Gebruik het in de URL om dat record bij te werken.

Bewaar de WaW-id naast je eigen record. Een eenvoudige koppeltabel volstaat:

Jouw record Klant WaW-id
Boeking 8421 Locatie A 3f1e9a2b-…
Klant 551 Locatie A 7b0c2f4e-…

Opnieuw proberen is veilig. Loopt een aanmaakaanvraag vast, stuur dan dezelfde aanvraag opnieuw. WaW herkent je external_id en geeft het record terug dat al bestaat, dus er komt nooit een dubbel. Lees Opnieuw proberen.

Stap 4: je gegevens vertalen naar WaW

Statussen. WaW heeft drie statussen: draft, confirmed en lost. Koppel elke status op je platform aan een van die drie, bijvoorbeeld:

Jouw status WaW-status
Aanvraag, optie of voorstel draft
Geboekt confirmed
Geannuleerd of afgewezen lost, met een reden

Datums. Stuur datums met een uur en een tijdzoneverschil, bijvoorbeeld 2027-06-12T16:00:00+02:00. Een datum zonder uur, of een uur zonder tijdzoneverschil, wordt geweigerd.

Locatie. location is verplicht bij een boeking. Voor een locatie is dat meestal de naam of het adres van de locatie, of de zaal.

Contacten. Stuur first_name en last_name voor personen. Stuur name met entity_type: "company" voor bedrijven.

Stap 5: testen, dan live

  1. Test op acceptatie. Gebruik https://acc-api.withoutaworry.com met een testsleutel van WaW. Maak enkele boekingen aan, werk ze bij en annuleer ze, en controleer ze in het WaW-testaccount.
  2. Ga live. Schakel over naar https://api.withoutaworry.com en de productiesleutel van de klant.

Acceptatiesleutels werken niet op productie, en productiesleutels werken niet op acceptatie.

Goed om te weten

  • Aanvraaglimiet. Elke klantsleutel staat 60 aanvragen per minuut toe. Krijg je 429, wacht dan het aantal seconden uit de header Retry-After. Zet je aanvragen per klant in een wachtrij.
  • De laatste wijziging wint. Past de klant een veld aan in WaW en werk jij hetzelfde veld later bij, dan vervangt jouw waarde die van de klant.
  • Wanneer een sleutel niet meer werkt. Een 403 betekent dat het abonnement van de klant afgelopen is of dat de koppeling is ingetrokken. Pauzeer de synchronisatie voor die klant en neem contact op met WaW.
  • Hulp nodig. Elke fout bevat een request_id. Stuur die naar WaW wanneer iets misloopt.

Checklist

  • Sleutels staan per klant, alleen op de server.
  • Contacten worden aangemaakt vóór boekingen.
  • Je eigen ID zit in external_id; de WaW-id staat naast je record.
  • Statussen zijn vertaald; annulaties worden lost met een reden.
  • Datums hebben een uur en een tijdzoneverschil.
  • Antwoorden 429 en 5xx worden met vertraging opnieuw geprobeerd.
  • Alles is eerst op acceptatie getest.
Navigatie

Type to search…

↑↓ navigate↵ selectEsc close