Partner API: Administrer nøkler og webhooks
Med Partner API kobler du egne bookingsider, apper og integrasjoner til STRYK. Du lager nøkler med akkurat de rettighetene som trengs, og setter opp webhooks.
Contents
Før du begynner
- Du trenger rettigheten Administrer kanaler. Bare da ser du raden API på siden Kanaler.
- Avklar hvilke områder integrasjonen må lese eller skrive. En nøkkel får bare disse rettighetene.
- En integrasjon kaller Partner API fra serveren sin. Nøkkelen legger du aldri inn i kode i nettleseren eller i en app. Endepunkter, parametere og eksempler finner du i Utviklerdokumentasjon. Der forklarer avsnittet Autentisering og scopes hva hver rettighet tillater.
- Webhooks krever en mottaker med en adresse som begynner med https://.
Åpne API
In STRYKKanaler
- Velg raden API med tillegget „API-nøkler og webhooks“ under Egne tilkoblinger. Dialogen API åpnes.
- Velg fanen API-nøkler eller Webhooks. Med Utviklerdokumentasjon i toppteksten på dialogen åpner du utviklerportalen.
- Fanene API-nøkler og Webhooks
- Nøkler med rettigheter
- Handlinger for nøkkelen
Opprett API-nøkkel
In STRYKKanalerAPIAPI-nøkler
- Velg Opprett API-nøkkel. Dialogen Opprett API-nøkkel åpnes.
- Skriv inn Navn, for eksempel „Bookingside“.
- Under Rettigheter velger du et mønster: Bare lesing (lese alle områder), Lesing og skriving (skrive der det er mulig) eller Egendefinert. Ved Egendefinert velger du for hvert område Ingen tilgang, Lesetilgang eller Skriv. Områdene er Hotell og rom, Tilgjengelighet, Priser og rateplaner, Bookinger, Gjester, Betalinger og Fakturaer. Skriv inkluderer Lesetilgang. Fakturaer er hotellets skattemessige bilag og kan bare leses via API.
- Valgfritt: Åpne Avansert. Velg Utløp: Ingen utløp, 30 dager, 90 dager, 1 år eller Dato (fra i morgen og høyst tre år frem i tid). Under IP-begrensning fører du inn en adresse eller et CIDR-nett per rad, høyst 20. Er feltet tomt, tillates alle adresser. Under Notat noterer du en intern merknad.
- Velg Opprett. STRYK viser API-nøkkel opprettet med nøkkelen og merknaden Bare synlig nå.
- Kopier nøkkelen og lagre den for eksempel i passordbehandleren. Velg Ferdig.
Administrer nøkler
In STRYKKanalerAPIAPI-nøkler
Listen viser for hver nøkkel Navn, begynnelsen av nøkkelen, Rettigheter, Opprettet, Sist brukt, Utløp og statusen: Aktiv, Utløper snart, Tilbakekalt eller Utløpt. Velg en nøkkel for å se Rettigheter, Utløp, Tillatte IP-adresser, Forespørselsgrense (forespørsler per minutt), Bruk, Siste forespørsler og Historikk.
- Åpne menyen Alternativer på raden.
- Velg Fornye hvis integrasjonen skal få en ny nøkkel med samme rettigheter. Velg under Nåværende nøkkel Gammel nøkkel fortsatt gyldig i 24 t, slik at du kan legge om integrasjonen, eller Trekk tilbake umiddelbart. Bekreft med Fornye. STRYK viser den nye nøkkelen én gang.
- Velg Trekk tilbake og bekreft Trekk tilbake API-nøkkel?, for å sperre en nøkkel umiddelbart. Forespørsler med denne nøkkelen avvises deretter av STRYK.
Sett opp webhooks
In STRYKKanalerAPIWebhooks
En webhook sender de valgte hendelsene signert via HTTPS til systemene dine.
- Velg Opprett webhook. Dialogen Ny webhook åpnes.
- Skriv inn Mottaker-URL, for eksempel https://crm.nordlicht.invalid/hooks/stryk. Adressen må begynne med https://.
- Valgfritt: Skriv inn en Beskrivelse, for eksempel „Bookinger til vårt CRM“.
- Velg under Hendelser minst én: Booking opprettet, Booking endret, Booking kansellert, Gjest endret, Tilgjengelighet endret, Pris endret, Betaling endret eller Romstatus endret. Med Velg alle og Fjern valg velger du alle eller ingen.
- Velg Opprett webhook. STRYK viser Din signeringshemmelighet én gang.
- Legg inn hemmeligheten i mottakeren din. Hvordan mottakeren kontrollerer signaturen, beskriver utviklerdokumentasjonen under Webhooks og signaturkontroll.
- Velg webhooken og deretter Send testhendelse. STRYK melder „Testhendelsen leveres.“
Administrer webhooks
Ort: Kanaler > API > Webhooks, velg webhooken
- Med bryteren Levering aktiv pauser eller aktiverer du webhooken. Pausede webhooks får ingen hendelser. Etter aktivering starter leveringen med nye hendelser.
- Siste 7 dager, Siste vellykkede og Siste feil viser status. Under Leveringer ser du hver levering med HTTP-status og Forsøk. Med Send på nytt gjentar du en levering.
- Forny hemmelighet lager en ny hemmelighet. Den forrige er fortsatt gyldig i 24 timer, slik at du kan legge om mottakeren.
- Med Rediger endrer du adresse og hendelser, med Slett og bekreftelsen Slett webhook? fjerner du den. Leveringsloggen beholdes i 30 dager.
Slik sjekker du resultatet
- På nøkkelen står Sist brukt med dato så snart integrasjonen tar den i bruk. Forespørsler 24 t teller forespørslene.
- På webhooken viser Siste 7 dager „{Zahl} levert, {Zahl} mislyktes“, og testhendelsen står under Leveringer.
Hvis noe ikke fungerer
| Hva du ser | Årsak | Slik løser du det |
|---|---|---|
| „Velg minst én rettighet.“ | Ingen område har en rettighet. | Velg et mønster, eller gi minst ett område Lesetilgang eller Skriv. |
| „Skriv inn et navn.“ | Navn mangler. | Skriv inn et navn. |
| „Kontroller:“ med en adresse | En adresse under IP-begrensning er ugyldig. | Korriger adressen eller CIDR-nettet. Tillatt er høyst 20 oppføringer. |
| „Velg en dato fra i morgen, høyst tre år frem i tid.“ | Utløpsdatoen ligger utenfor perioden. | Velg en dato fra i morgen som ligger høyst tre år frem i tid. |
| „Adressen må begynne med https://.“ | Mottaker-URL er ikke en HTTPS-adresse. | Skriv inn en adresse med https://. |
| „Velg minst én hendelse.“ | Webhooken har ingen hendelse. | Velg minst én under Hendelser. |
| Pauset på grunn av gjentatte feil | Mottakeren svarer ikke med en 2xx-status. | Kontroller at mottakeren er tilgjengelig, og velg Aktiver på nytt. |
| „Aktiver webhooken for å sende en testhendelse.“ | Webhooken er pauset. | Aktiver Levering aktiv og send testhendelsen. |
| „Valget kunne ikke lastes. Lukk og åpne det igjen.“ | Listen over rettigheter og hendelser er ikke lastet. | Lukk dialogen og åpne den på nytt. |