Partner API: hantera nycklar och webhooks
Med Partner API kopplar du egna bokningssidor, appar och integrationer till STRYK. Du skapar nycklar med exakt de behörigheter som behövs och ställer in webhooks.
Contents
Innan du börjar
- Du behöver behörigheten Hantera kanaler. Först då ser du raden API på sidan Kanaler.
- Ta reda på vilka områden integrationen måste läsa eller skriva. En nyckel får bara dessa behörigheter.
- En integration anropar Partner API från sin server. Nyckeln lägger du aldrig i kod för webbläsaren eller i en app. Endpoints, parametrar och exempel finns i utvecklardokumentationen. Där förklarar avsnittet Autentisering och scopes vad varje behörighet tillåter.
- Webhooks kräver en mottagare med en adress som börjar med https://.
Öppna API
In STRYKKanaler
- Välj raden API under Egna anslutningar med tillägget ”API-nycklar och webhooks”. Dialogen API öppnas.
- Välj fliken API-nycklar eller Webhooks. Med Utvecklardokumentation i dialogens sidhuvud öppnar du utvecklarportalen.
- Flikarna API-nycklar och Webhooks
- Nycklar med behörigheter
- Nyckelns åtgärder
Skapa API-nyckel
In STRYKKanalerAPIAPI-nycklar
- Välj Skapa API-nyckel. Dialogen Skapa API-nyckel öppnas.
- Ange Namn, till exempel ”Bokningssida”.
- Välj ett mönster under Behörigheter: Endast läsning (läs alla områden), Läsa och skriva (skriva där det är möjligt) eller Anpassad. Vid Anpassad väljer du per område Ingen åtkomst, Läsa eller Skriva. Områdena är Hotell och rum, Tillgänglighet, Priser och prisplaner, Bokningar, Gäster, Betalningar och Fakturor. Skriva inkluderar Läsa. Fakturor är hotellets skattemässiga kvitton och kan bara läsas via API.
- Valfritt: Öppna Avancerat. Välj Utgång: Ingen utgång, 30 dagar, 90 dagar, 1 år eller Datum (från i morgon, högst tre år framåt). Under IP-begränsning anger du per rad en adress eller ett CIDR-nät, högst 20. Tomt tillåter alla adresser. Under Obs kan du hålla fast en intern anteckning.
- Välj Skapa. STRYK visar API-nyckel skapad med nyckeln och meddelandet Visas bara nu.
- Kopiera nyckeln och spara den till exempel i din lösenordshanterare. Välj Klar.
Hantera nycklar
In STRYKKanalerAPIAPI-nycklar
Listan visar för varje nyckel Namn, början av nyckeln, Behörigheter, Skapad, Senast använd, Utgång och statusen: Aktiv, Går snart ut, Återkallad eller Utgången. Välj en nyckel för att se Behörigheter, Utgång, Tillåtna IP-adresser, Anropsgräns (anrop per minut), Användning, Senaste anrop och Historik.
- Öppna menyn Alternativ på raden.
- Välj Förnya om integrationen ska få en ny nyckel med samma behörigheter. Under Nuvarande nyckel väljer du Gammal nyckel giltig i 24 h till, så att du hinner byta i integrationen, eller Återkalla direkt. Bekräfta med Förnya. STRYK visar den nya nyckeln en gång.
- Välj Återkalla och bekräfta Återkalla API-nyckel? för att spärra en nyckel direkt. STRYK avvisar då anrop med den nyckeln.
Ställ in webhooks
In STRYKKanalerAPIWebhooks
En webhook skickar de valda händelserna signerat över HTTPS till dina system.
- Välj Skapa webhook. Dialogen Ny webhook öppnas.
- Ange Mottagar-URL, till exempel https://crm.nordlicht.invalid/hooks/stryk. Adressen måste börja med https://.
- Valfritt: Ange en Beskrivning, till exempel ”Bokningar till vårt CRM”.
- Välj minst en under Händelser: Bokning skapad, Bokning ändrad, Bokning avbruten, Gäst ändrad, Tillgänglighet ändrad, Pris ändrat, Betalning ändrad eller Rumsstatus ändrad. Med Markera alla och Avmarkera väljer du alla eller inga.
- Välj Skapa webhook. STRYK visar Din signeringshemlighet en gång.
- Lägg in hemligheten i din mottagare. Hur mottagaren kontrollerar signaturen beskrivs i utvecklardokumentationen under Webhooks och signaturkontroll.
- Välj webhooken och sedan Skicka testhändelse. STRYK meddelar ”Testhändelsen levereras.”
Hantera webhooks
Ort: Kanaler > API > Webhooks, välj webhooken
- Med reglaget Leverans aktiv pausar eller aktiverar du webhooken. Pausade webhooks tar inte emot några händelser. Efter aktivering börjar leveransen med nya händelser.
- Senaste 7 dagarna, Senaste lyckade och Senaste fel visar läget. Under Leveranser ser du varje leverans med HTTP-status och Försök. Med Skicka igen upprepar du en leverans.
- Förnya hemlighet skapar en ny hemlighet. Den tidigare förblir giltig i 24 timmar så att du kan byta i mottagaren.
- Med Redigera ändrar du adress och händelser. Med Ta bort och bekräftelsen Ta bort webhooken? tar du bort den. Leveransloggen sparas i 30 dagar.
Så kontrollerar du resultatet
- På nyckeln står Senast använd med datum så snart integrationen använder den. Anrop 24 h räknar anropen.
- På webhooken visar Senaste 7 dagarna ”{Zahl} levererade, {Zahl} misslyckade”, och testhändelsen står under Leveranser.
Om något inte fungerar
| Vad du ser | Orsak | Så löser du det |
|---|---|---|
| „Välj minst en behörighet.“ | Inget område har en behörighet. | Välj ett mönster eller ge minst ett område Läsa eller Skriva. |
| „Ange ett namn.“ | Namn saknas. | Ange ett namn. |
| „Kontrollera:“ med en adress | En adress under IP-begränsning är ogiltig. | Rätta adressen eller CIDR-nätet. Högst 20 poster är tillåtna. |
| „Ange ett datum från i morgon, högst tre år framåt.“ | Utgångsdatumet ligger utanför tillåtet intervall. | Välj ett datum från i morgon som ligger högst tre år fram i tiden. |
| „Adressen måste börja med https://.“ | Mottagar-URL är ingen HTTPS-adress. | Ange en adress som börjar med https://. |
| „Välj minst en händelse.“ | Webhooken har ingen händelse. | Välj minst en under Händelser. |
| Pausad efter upprepade fel | Mottagaren svarar inte med en 2xx-status. | Kontrollera att mottagaren går att nå och välj Återaktivera. |
| „Aktivera webhooken för att skicka en testhändelse.“ | Webhooken är pausad. | Aktivera Leverans aktiv och skicka testhändelsen. |
| „Urvalet kunde inte läsas in. Stäng och öppna igen.“ | Listan över behörigheter och händelser är inte inläst. | Stäng dialogen och öppna den igen. |