Partner API: upravljanje ključevima i webhookovima
Partner API povezuje tvoje vlastite stranice za rezervacije, aplikacije i integracije sa STRYK-om. Izrađuješ ključeve s točno potrebnim pravima i postavljaš webhookove.
Contents
Prije nego što počneš
- Trebaš pravo Upravljanje kanalima. Samo tada vidiš redak API na stranici Kanali.
- Razjasni koja područja integracija mora čitati ili pisati. Ključ dobiva samo ta prava.
- Integracija poziva Partner API sa svog poslužitelja. Ključ nikada ne stavljaš u kod preglednika ili u aplikaciju. Krajnje točke, parametre i primjere nalaziš u Dokumentaciji za programere. Tamo odjeljak Autentifikacija i opsezi objašnjava što svako pravo dopušta.
- Webhookovi trebaju primatelja s adresom koja počinje s https://.
Otvori API
In STRYKKanali
- Pod Vlastite veze odaberi redak API s dodatkom „API ključevi i webhookovi“. Otvara se dijalog API.
- Odaberi karticu API ključevi ili Webhookovi. Gumbom Dokumentacija za programere u zaglavlju dijaloga otvaraš razvojni portal.
- Kartice API ključevi i Webhookovi
- Ključ s pravima
- Radnje ključa
Izradi API ključ
In STRYKKanaliAPIAPI ključevi
- Odaberi Izradi API ključ. Otvara se dijalog Izradi API ključ.
- Unesi Naziv, na primjer „Stranica za rezervacije“.
- Pod Prava odaberi obrazac: Samo čitanje (čitanje svih područja), Čitanje i pisanje (pisanje gdje je moguće) ili Prilagođeno. Kod Prilagođeno za svako područje odaberi Bez pristupa, Čitanje ili Pisanje. Područja su Hotel i sobe, Raspoloživost, Cijene i tarife, Rezervacije, Gosti, Plaćanja i Računi. Pisanje uključuje Čitanje. Računi su fiskalni dokumenti hotela i preko API-ja se mogu samo čitati.
- Opcionalno: otvori Napredno. Odaberi Istek: Bez isteka, 30 dana, 90 dana, 1 godina ili Datum (od sutra, najviše tri godine unaprijed). Pod IP ograničenje upiši u svaki red adresu ili CIDR mrežu, najviše 20. Prazno dopušta sve adrese. Pod Napomena zabilježi interni podsjetnik.
- Odaberi Stvori. STRYK prikazuje API ključ izrađen s ključem i napomenom Vidljivo samo sada.
- Kopiraj ključ i spremi ga, na primjer, u upravitelj lozinki. Odaberi Gotovo.
Upravljanje ključevima
In STRYKKanaliAPIAPI ključevi
Popis za svaki ključ prikazuje Naziv, početak ključa, Prava, Stvoreno, Zadnje korišteno, Istek i status: Aktivno, Uskoro istječe, Opozvano ili Istekao. Odaberi ključ da vidiš Prava, Istek, Dopuštene IP adrese, Ograničenje zahtjeva (zahtjeva po minuti), Korištenje, Nedavni zahtjevi i Povijest.
- U retku otvori izbornik Mogućnosti.
- Odaberi Ponovno generiraj ako integracija treba novi ključ s istim pravima. Pod Dosadašnji ključ odaberi Stari ključ vrijedi još 24 h da možeš prebaciti integraciju, ili Odmah opozovi. Potvrdi s Ponovno generiraj. STRYK novi ključ prikazuje jednom.
- Odaberi Opozovi i potvrdi Opozvati API ključ? da odmah blokiraš ključ. STRYK tada odbija zahtjeve s tim ključem.
Webhookovi postavljanje
In STRYKKanaliAPIWebhookovi
Webhook šalje odabrane događaje potpisane putem HTTPS-a na tvoje sustave.
- Odaberi Izradi webhook. Otvara se dijalog Novi webhook.
- Unesi URL primatelja, na primjer https://crm.nordlicht.invalid/hooks/stryk. Adresa mora početi s https://.
- Opcionalno: unesi Opis, na primjer „Rezervacije u naš CRM“.
- Pod Događaji odaberi najmanje jedan: Rezervacija izrađena, Rezervacija izmijenjena, Rezervacija otkazana, Gost izmijenjen, Dostupnost promijenjena, Cijena promijenjena, Plaćanje izmijenjeno ili Status sobe promijenjen. Gumbima Odaberi sve i Poništi odabir odabireš sve ili nijedan.
- Odaberi Izradi webhook. STRYK prikazuje Tvoja tajna za potpisivanje samo jednom.
- Spremi tajnu u svoj primatelj. Kako primatelj provjerava potpis, opisuje razvojna dokumentacija pod Webhookovi i provjera potpisa.
- Odaberi webhook, zatim Pošalji testni događaj. STRYK javlja „Testni događaj se isporučuje.“
Upravljanje webhookovima
Ort: Kanali > API > Web-dojavice, odaberi web-dojavicu
- Prekidačem Isporuka aktivna pauziraš ili aktiviraš webhook. Pauzirani webhookovi ne primaju događaje. Nakon aktiviranja isporuka počinje s novim događajima.
- Zadnjih 7 dana, Zadnji uspjeh i Zadnja pogreška pokazuju stanje. Pod Isporuke vidiš svaku isporuku sa Status HTTP-a i Pokušaji. Gumbom Pošalji ponovno ponavljaš isporuku.
- Obnovi tajnu stvara novu tajnu. Dosadašnja ostaje važeća još 24 sata da možeš prebaciti primatelja.
- Gumbom Uredi mijenjaš adresu i događaje, a s Izbriši i potvrdom Izbrisati webhook? ga uklanjaš. Protokol isporuke čuva se 30 dana.
Kako provjeriti rezultat
- Kod ključa piše Zadnje korišteno s datumom čim ga integracija koristi. Zahtjevi 24 h broji zahtjeve.
- Kod webhooka Zadnjih 7 dana prikazuje „{Zahl} isporučeno, {Zahl} neuspjelo“, a testni događaj stoji pod Isporuke.
Ako nešto ne radi
| Što vidiš | Uzrok | Kako to riješiti |
|---|---|---|
| „Odaberi barem jedno pravo.“ | Nijedno područje nema pravo. | Odaberi obrazac ili dodijeli barem jednom području Čitanje ili Pisanje. |
| „Unesi naziv.“ | Naziv nedostaje. | Upiši naziv. |
| „Provjeri:“ s adresom | Jedna adresa u IP ograničenje nije ispravna. | Ispravi adresu ili CIDR mrežu. Dopušteno je najviše 20 unosa. |
| „Odaberi datum od sutra, najviše tri godine unaprijed.“ | Datum isteka je izvan dopuštenog razdoblja. | Odaberi datum od sutra koji je najviše tri godine unaprijed. |
| „Adresa mora početi s https://.“ | URL primatelja nije HTTPS adresa. | Upiši adresu s https://. |
| „Odaberi barem jedan događaj.“ | Webhook nema nijedan događaj. | Pod Događaji odaberi barem jedan. |
| Pauzirano zbog ponovljenih pogrešaka | Primatelj ne odgovara statusom 2xx. | Provjeri je li primatelj dostupan i odaberi Ponovno aktiviraj. |
| „Aktiviraj webhook da pošalješ testni događaj.“ | Webhook je pauziran. | Aktiviraj Isporuka aktivna i pošalji testni događaj. |
| „Odabir nije moguće učitati. Zatvori ga i ponovno otvori.“ | Popis prava i događaja nije učitan. | Zatvori dijalog i ponovno ga otvori. |