Partner API: gestionează chei și webhook-uri
Cu Partner API conectezi site-urile tale de rezervări, aplicațiile și integrările cu STRYK. Creezi chei cu drepturile exact necesare și configurezi webhook-uri.
Contents
Înainte de a începe
- Ai nevoie de dreptul Gestionează canalele. Doar cu el vezi rândul API pe pagina Canale.
- Stabilește ce zone trebuie integrarea să le citească sau să le modifice. O cheie primește doar aceste drepturi.
- O integrare apelează Partner API de pe serverul ei. Cheia nu o pui niciodată în codul din browser sau într-o aplicație. Endpoint-urile, parametrii și exemplele le găsești în Documentația pentru dezvoltatori. Acolo explică secțiunea Autentificare și scopuri ce permite fiecare drept.
- Webhook-urile necesită un destinatar cu o adresă care începe cu https://.
Deschide API
In STRYKCanale
- Alege sub Conexiuni proprii rândul API cu adăugirea „Chei API și webhook-uri”. Se deschide dialogul API.
- Alege tabul Chei API sau Webhook-uri. Cu Documentație pentru dezvoltatori din antetul dialogului deschizi portalul pentru dezvoltatori.
- Taburile Chei API și Webhook-uri
- Cheie cu drepturi
- Acțiunile cheii
Creează chei API
In STRYKCanaleAPIChei API
- Alege Creează cheie API. Se deschide dialogul Creează cheie API.
- Completează Nume, de exemplu „Pagina de rezervări”.
- Alege la Drepturi un model: Doar citire (citește toate zonele), Citire și scriere (scrie acolo unde este posibil) sau Personalizat. La Personalizat alegi pentru fiecare zonă Fără acces, Citire sau Scriere. Zonele sunt Hotel și camere, Disponibilitate, Prețuri și tarife, Rezervări, Oaspeți, Plăți și Facturi. Scriere include Citire. Facturile sunt documente fiscale ale hotelului și se pot citi doar prin API.
- Opțional: deschide Avansat. Alege Expirare: Fără expirare, 30 de zile, 90 de zile, 1 an sau Dată (de mâine, cel mult trei ani). Completează la Restricție IP pe fiecare rând o adresă sau o rețea CIDR, cel mult 20. Lăsat gol, sunt permise toate adresele. La Notă notezi o indicație internă.
- Alege Creează. STRYK afișează Cheie API creată cu cheia și notificarea Vizibil doar acum.
- Copiază cheia și salvează-o, de exemplu, în managerul de parole. Alege Gata.
Gestionează cheile
In STRYKCanaleAPIChei API
Lista afișează pentru fiecare cheie Nume, începutul cheii, Drepturi, Creat, Ultima utilizare, Expirare și starea: Activ, Expiră curând, Revocat sau Expirat. Alege o cheie ca să vezi Drepturi, Expirare, Adrese IP permise, Limită de cereri (cereri pe minut), Utilizare, Cereri recente și Istoric.
- Deschide în rând meniul Opțiuni.
- Alege Regenerează, dacă integrarea trebuie să primească o cheie nouă cu aceleași drepturi. Alege la Cheia actuală Cheia veche rămâne valabilă 24 h, ca să poți schimba integrarea, sau Revocă imediat. Confirmă cu Regenerează. STRYK afișează cheia nouă o singură dată.
- Alege Revocă și confirmă Revocă cheia API?, ca să blochezi imediat o cheie. Cererile cu această cheie sunt refuzate de STRYK.
Configurează webhook-urile
In STRYKCanaleAPIWebhook-uri
Un webhook trimite evenimentele alese, semnate, prin HTTPS către sistemele tale.
- Alege Creează webhook. Se deschide dialogul Webhook nou.
- Completează URL destinatar, de exemplu https://crm.nordlicht.invalid/hooks/stryk. Adresa trebuie să înceapă cu https://.
- Opțional: completează Descriere, de exemplu „Rezervări către CRM-ul nostru”.
- Alege la Evenimente cel puțin unul: Rezervare creată, Rezervare modificată, Rezervare anulată, Oaspete modificat, Disponibilitate modificată, Preț modificat, Plată modificată sau Stare cameră modificată. Cu Selectează tot și Anulează selecția alegi toate sau niciunul.
- Alege Creează webhook. STRYK afișează Secretul de semnare o singură dată.
- Introdu secretul în destinatarul tău. Cum verifică destinatarul semnătura, descrie documentația pentru dezvoltatori la Webhook-uri și verificarea semnăturii.
- Alege webhookul și apoi Trimite eveniment de test. STRYK afișează „Evenimentul de test se livrează.”
Gestionează webhook-urile
Ort: Canale > API > Webhook-uri, alege webhook-ul
- Cu comutatorul Livrare activă oprești sau activezi webhookul. Webhookurile oprite nu primesc evenimente. După activare, livrarea începe cu evenimente noi.
- Ultimele 7 zile, Ultimul succes și Ultima eroare arată starea. Sub Livrări vezi fiecare livrare cu Stare HTTP și Încercări. Cu Trimite din nou repeți o livrare.
- Reînnoiește secretul generează un secret nou. Cel vechi rămâne valabil încă 24 de ore, ca să poți trece destinatarul la noul secret.
- Cu Editează modifici adresa și evenimentele, cu Șterge și confirmarea Șterge webhookul? îl elimini. Jurnalul de livrare rămâne păstrat 30 de zile.
Verifică rezultatul
- La cheie apare Ultima utilizare cu data, de îndată ce integrarea o folosește. Cereri 24 h numără cererile.
- La webhook, Ultimele 7 zile afișează „{Zahl} livrate, {Zahl} eșuate”, iar evenimentul de test apare sub Livrări.
Dacă ceva nu funcționează
| Ce vezi | Cauză | Cum rezolvi |
|---|---|---|
| „Alege cel puțin un drept.” | Nicio zonă nu are un drept. | Alege un model sau acordă cel puțin unei zone Citire sau Scriere. |
| „Introdu un nume.” | Lipsește Nume. | Completează un nume. |
| „Verifică:” cu o adresă | O adresă din Restricție IP nu este validă. | Corectează adresa sau rețeaua CIDR. Sunt permise cel mult 20 de intrări. |
| „Alege o dată de mâine, cel mult peste trei ani.” | Data de expirare este în afara intervalului. | Alege o dată de mâine, situată cel mult trei ani în viitor. |
| „Adresa trebuie să înceapă cu https://.” | URL destinatar nu este o adresă HTTPS. | Introdu o adresă care începe cu https://. |
| „Alege cel puțin un eveniment.” | Webhookul nu are niciun eveniment. | Alege cel puțin unul la Evenimente. |
| Întrerupt din cauza erorilor repetate | Destinatarul nu răspunde cu o stare 2xx. | Verifică dacă destinatarul este accesibil și alege Reactivează. |
| „Activează webhookul ca să trimiți un eveniment de test.” | Webhookul este oprit. | Activează Livrare activă și trimite evenimentul de test. |
| „Selecția nu a putut fi încărcată. Închide și deschide din nou.” | Lista drepturilor și evenimentelor nu s-a încărcat. | Închide dialogul și deschide-l din nou. |