Partner API: administrer nøgler og webhooks
Med Partner API forbinder du egne bookingsider, apps og integrationer med STRYK. Du opretter nøgler med præcis de nødvendige rettigheder og opsætter webhooks.
Contents
Før du går i gang
- Du skal bruge rettigheden Administrer kanaler. Kun med den ser du rækken API på siden Kanaler.
- Afklar, hvilke områder integrationen skal læse eller skrive. En nøgle får kun disse rettigheder.
- En integration kalder Partner API fra sin server. Nøglen lægger du aldrig i browserkode eller i en app. Endpunkter, parametre og eksempler finder du i Udviklerdokumentation. Afsnittet Autentificering og scopes forklarer, hvad hver rettighed tillader.
- Webhooks kræver en modtager med en adresse, der begynder med https://.
Åbn API
In STRYKKanaler
- Vælg under Egne forbindelser rækken API med tilføjelsen „API-nøgler og webhooks“. Dialogen API åbner sig.
- Vælg fanen API-nøgler eller Webhooks. Med Udviklerdokumentation i dialogens hovedlinje åbner du udviklerportalen.
- Fanerne API-nøgler og Webhooks
- Nøgle med rettigheder
- Handlinger for nøglen
Opret API-nøgle
In STRYKKanalerAPIAPI-nøgler
- Vælg Opret API-nøgle. Dialogen Opret API-nøgle åbner sig.
- Indtast Navn, for eksempel „Bookingside“.
- Vælg under Rettigheder et mønster: Kun læse (læs alle områder), Læse og skrive (skriv, hvor det er muligt) eller Brugerdefineret. Ved Brugerdefineret vælger du for hvert område Ingen adgang, Læsning eller Skrive. Områderne er Hotel og værelser, Tilgængelighed, Priser og prisplaner, Bestillinger, Gæster, Betalinger og Fakturaer. Skrive inkluderer Læsning. Fakturaer er hotellets regnskabsbilag og kan kun læses via API.
- Valgfrit: Åbn Avanceret. Vælg Udløb: Intet udløb, 30 dage, 90 dage, 1 år eller Dato (fra i morgen, højst tre år frem). Under IP-begrænsning indtaster du pr. linje en adresse eller et CIDR-netværk, højst 20. Tomt tillader alle adresser. Under Bemærkning noterer du en intern note.
- Vælg Opret. STRYK viser API-nøgle oprettet med nøglen og henvisningen Vises kun nu.
- Kopiér nøglen og gem den for eksempel i din adgangskodeadministrator. Vælg Færdig.
Administrer nøgler
In STRYKKanalerAPIAPI-nøgler
Listen viser pr. nøgle Navn, begyndelsen af nøglen, Rettigheder, Oprettet, Sidst brugt, Udløb og status: Aktiv, Udløber snart, Tilbagekaldt eller Udløbet. Vælg en nøgle for at se Rettigheder, Udløb, Tilladte IP-adresser, Anmodningsgrænse (anmodninger pr. minut), Brug, Seneste kald og Historik.
- Åbn menuen Valgmuligheder i rækken.
- Vælg Forny, hvis integrationen skal have en ny nøgle med de samme rettigheder. Vælg under Nuværende nøgle Gammel nøgle gyldig i 24 t endnu, så du kan skifte integrationen over, eller Tilbagekald straks. Bekræft med Forny. STRYK viser den nye nøgle én gang.
- Vælg Tilbagekald og bekræft Tilbagekald API-nøgle? for at spærre en nøgle med det samme. Anmodninger med denne nøgle afviser STRYK derefter.
Opsæt webhooks
In STRYKKanalerAPIWebhooks
En webhook sender de valgte begivenheder signeret via HTTPS til dine systemer.
- Vælg Opret webhook. Dialogen Ny webhook åbner sig.
- Indtast Modtager-URL, for eksempel https://crm.nordlicht.invalid/hooks/stryk. Adressen skal begynde med https://.
- Valgfrit: Indtast en Beskrivelse, for eksempel „Bookinger til vores CRM“.
- Vælg under Hændelser mindst én: Booking oprettet, Booking ændret, Booking annulleret, Gæst ændret, Tilgængelighed ændret, Pris ændret, Betaling ændret eller Værelsesstatus ændret. Med Vælg alle og Fravælg vælger du alle eller ingen.
- Vælg Opret webhook. STRYK viser Din signeringshemmelighed én gang.
- Gem hemmeligheden hos din modtager. Hvordan modtageren kontrollerer signaturen, beskriver udviklerdokumentationen under Webhooks og signaturkontrol.
- Vælg webhooken og derefter Send testhændelse. STRYK melder „Testhændelse leveres.“
Administrer webhooks
Ort: Kanaler > API > Webhooks, vælg en webhook
- Med kontakten Levering aktiv sætter du webhooken på pause eller aktiverer den. Pausede webhooks modtager ingen begivenheder. Efter aktivering begynder leveringen med nye begivenheder.
- Seneste 7 dage, Seneste succes og Seneste fejl viser status. Under Leveringer ser du hver levering med HTTP-status og Forsøg. Med Send igen gentager du en levering.
- Forny hemmelighed opretter en ny hemmelighed. Den hidtidige forbliver gyldig i 24 timer, så du kan skifte modtageren.
- Med Rediger ændrer du adresse og begivenheder. Med Slet og bekræftelsen Slet webhooken? fjerner du den. Leveringsprotokollen gemmes i 30 dage.
Sådan kontrollerer du resultatet
- Ved nøglen står Sidst brugt med dato, så snart integrationen bruger den. Kald 24 t tæller anmodningerne.
- Ved webhooken viser Seneste 7 dage „{Zahl} leveret, {Zahl} mislykkedes“, og testhændelsen står under Leveringer.
Hvis noget ikke virker
| Hvad du ser | Årsag | Sådan løser du det |
|---|---|---|
| „Vælg mindst én rettighed.“ | Intet område har en rettighed. | Vælg et mønster, eller giv mindst ét område Læsning eller Skrive. |
| „Indtast et navn.“ | Navn mangler. | Indtast et navn. |
| „Kontrollér:“ med en adresse | En adresse under IP-begrænsning er ugyldig. | Ret adressen eller CIDR-netværket. Højst 20 poster er tilladt. |
| „Vælg en dato fra i morgen, højst tre år frem.“ | Udløbsdatoen ligger uden for perioden. | Vælg en dato fra i morgen, der højst ligger tre år ude i fremtiden. |
| „Adressen skal begynde med https://.“ | Modtager-URL er ikke en HTTPS-adresse. | Indtast en adresse med https://. |
| „Vælg mindst én begivenhed.“ | Webhooken har ingen begivenhed. | Vælg mindst én under Begivenheder. |
| Sat på pause efter gentagne fejl | Modtageren svarer ikke med en 2xx-status. | Kontrollér, at modtageren kan nås, og vælg Aktivér igen. |
| „Aktivér webhooken for at sende en testhændelse.“ | Webhooken er sat på pause. | Aktivér Levering aktiv, og send testhændelsen. |
| „Valget kunne ikke indlæses. Luk og åbn igen.“ | Listen over rettigheder og begivenheder er ikke indlæst. | Luk dialogen, og åbn den igen. |