Partner API: sleutels en webhooks beheren
Met de Partner API koppel je eigen boekingspagina's, apps en integraties aan STRYK. Je maakt sleutels met precies de nodige rechten en stelt webhooks in.
Contents
Voordat je begint
- Je hebt het recht Kanalen beheren nodig. Alleen dan zie je de regel API op de pagina Kanalen.
- Bepaal welke onderdelen de integratie moet lezen of schrijven. Een sleutel krijgt alleen deze rechten.
- Een integratie roept de Partner API aan vanaf je server. Plaats de sleutel nooit in browsercode of in een app. Endpoints, parameters en voorbeelden vind je in de Ontwikkelaarsdocumentatie. Daar legt de sectie Authenticatie en scopes uit wat elk recht toestaat.
- Webhooks hebben een ontvanger nodig met een adres dat begint met https://.
API openen
In STRYKKanalen
- Kies onder Eigen koppelingen de regel API met de toevoeging „API-sleutels en webhooks“. Het dialoogvenster API opent zich.
- Kies het tabblad API-sleutels of Webhooks. Met Ontwikkelaarsdocumentatie in de koptekst van het dialoogvenster open je het ontwikkelaarsportaal.
- Tabs API-sleutels en Webhooks
- Sleutel met rechten
- Acties van de sleutel
API-sleutel aanmaken
In STRYKKanalenAPIAPI-sleutels
- Kies API-sleutel aanmaken. Het dialoogvenster API-sleutel aanmaken opent zich.
- Vul bij Naam een naam in, bijvoorbeeld „Boekingspagina“.
- Kies onder Rechten een patroon: Alleen lezen (alle onderdelen lezen), Lezen en schrijven (schrijven waar dat kan) of Aangepast. Bij Aangepast kies je per onderdeel Geen toegang, Lezen of Schrijven. De onderdelen zijn Hotel en kamers, Beschikbaarheid, Prijzen & tarieven, Boekingen, Gasten, Betalingen en Facturen. Schrijven omvat Lezen. Facturen zijn fiscale bewijzen van het hotel en je kunt ze via de API alleen lezen.
- Optioneel: open Geavanceerd. Kies de Vervaldatum: Geen vervaldatum, 30 dagen, 90 dagen, 1 jaar of Datum (vanaf morgen, maximaal drie jaar). Vul bij IP-beperking per regel een adres of CIDR-netwerk in, maximaal 20. Leeg betekent dat alle adressen zijn toegestaan. Onder Notitie bewaar je een interne opmerking.
- Kies Aanmaken. STRYK toont API-sleutel aangemaakt met de sleutel en de melding Alleen nu zichtbaar.
- Kopieer de sleutel en sla hem op, bijvoorbeeld in je wachtwoordmanager. Kies Klaar.
Sleutels beheren
In STRYKKanalenAPIAPI-sleutels
De lijst toont per sleutel de Naam, het begin van de sleutel, de Rechten, Gemaakt, Laatst gebruikt, de Vervaldatum en de status: Actief, Verloopt binnenkort, Ingetrokken of Verlopen. Kies een sleutel om de Rechten, de Vervaldatum, de Toegestane IP-adressen, de Aanvraaglimiet (verzoeken per minuut), het Gebruik, de Recente verzoeken en de Geschiedenis te zien.
- Open in de regel het menu Opties.
- Kies Opnieuw genereren als de integratie een nieuwe sleutel met dezelfde rechten moet krijgen. Kies bij Huidige sleutel Oude sleutel nog 24 u geldig, zodat je de integratie kunt omzetten, of Meteen intrekken. Bevestig met Opnieuw genereren. STRYK toont de nieuwe sleutel één keer.
- Kies Intrekken en bevestig API-sleutel intrekken? om een sleutel direct te blokkeren. Verzoeken met deze sleutel wijst STRYK daarna af.
Webhooks instellen
In STRYKKanalenAPIWebhooks
Een webhook stuurt de gekozen gebeurtenissen ondertekend via HTTPS naar je systemen.
- Kies Webhook aanmaken. Het dialoogvenster Nieuwe webhook opent zich.
- Vul de Ontvanger-URL in, bijvoorbeeld https://crm.nordlicht.invalid/hooks/stryk. Het adres moet beginnen met https://.
- Optioneel: vul een Beschrijving in, bijvoorbeeld „Boekingen naar ons CRM“.
- Kies onder Evenementen minstens één: Boeking aangemaakt, Boeking gewijzigd, Boeking geannuleerd, Gast gewijzigd, Beschikbaarheid gewijzigd, Prijs gewijzigd, Betaling gewijzigd of Kamerstatus gewijzigd. Met Alles selecteren en Selectie opheffen kies je alle of geen.
- Kies Webhook aanmaken. STRYK toont Je ondertekeningsgeheim één keer.
- Sla het geheim op in je ontvanger. Hoe de ontvanger de handtekening controleert, staat in de Ontwikkelaarsdocumentatie onder Webhooks en controle van de handtekening.
- Kies de webhook en daarna Testgebeurtenis versturen. STRYK meldt „Testgebeurtenis wordt afgeleverd.“
Webhooks beheren
Ort: Kanalen > API > Webhooks, kies een webhook
- Met de schakelaar Aflevering actief pauzeer of activeer je de webhook. Gepauzeerde webhooks ontvangen geen gebeurtenissen. Na het activeren begint de aflevering met nieuwe gebeurtenissen.
- Laatste 7 dagen, Laatste succes en Laatste fout tonen de stand. Onder Afleveringen zie je elke aflevering met de HTTP-status en de Pogingen. Met Opnieuw verzenden herhaal je een aflevering.
- Geheim vernieuwen maakt een nieuw geheim aan. Het vorige blijft nog 24 uur geldig, zodat je de ontvanger kunt omzetten.
- Met Bewerken wijzig je adres en gebeurtenissen. Met Verwijderen en de bevestiging Webhook verwijderen? haal je hem weg. Het afleverprotocol blijft 30 dagen bewaard.
Zo controleer je het resultaat
- Bij de sleutel staat Laatst gebruikt met een datum zodra de integratie hem gebruikt. Verzoeken 24 u telt de verzoeken.
- Bij de webhook toont Laatste 7 dagen „{Zahl} afgeleverd, {Zahl} mislukt“, en de testgebeurtenis staat onder Afleveringen.
Als het niet lukt
| Wat je ziet | Oorzaak | Zo los je het op |
|---|---|---|
| „Kies minstens één recht.“ | Geen enkel onderdeel heeft een recht. | Kies een patroon of geef minstens één onderdeel Lezen of Schrijven. |
| „Vul een naam in.“ | De Naam ontbreekt. | Vul een naam in. |
| „Controleer:“ met een adres | Een adres in de IP-beperking is ongeldig. | Corrigeer het adres of het CIDR-netwerk. Toegestaan zijn maximaal 20 vermeldingen. |
| „Kies een datum vanaf morgen, maximaal drie jaar vooruit.“ | De vervaldatum ligt buiten de toegestane periode. | Kies een datum vanaf morgen die maximaal drie jaar in de toekomst ligt. |
| „Het adres moet beginnen met https://.“ | De Ontvanger-URL is geen HTTPS-adres. | Vul een adres in dat begint met https://. |
| „Kies minstens één evenement.“ | De webhook heeft geen evenement. | Kies onder Evenementen minstens één. |
| Gepauzeerd na herhaalde fouten | De ontvanger antwoordt niet met een 2xx-status. | Controleer of de ontvanger bereikbaar is en kies Opnieuw activeren. |
| „Activeer de webhook om een testgebeurtenis te versturen.“ | De webhook is gepauzeerd. | Activeer Aflevering actief en verstuur de testgebeurtenis. |
| „De keuze kon niet worden geladen. Sluit het venster en open het opnieuw.“ | De lijst met rechten en gebeurtenissen is niet geladen. | Sluit het dialoogvenster en open het opnieuw. |