Partner API: upravljanje ključevima i webhookovima
Partner API povezuje tvoje vlastite stranice za rezervacije, aplikacije i integracije sa STRYK. Kreiraš ključeve s točno potrebnim pravima i postavljaš webhookove.
Contents
Prije nego što počneš
- Potrebno ti je pravo Upravljanje channelima. Samo s njim vidiš red API na stranici Kanali.
- Razjasni koja područja integracija mora čitati ili upisivati. Ključ dobija samo ta prava.
- Integracija poziva Partner API sa svog servera. Ključ nikad ne stavljaš u kod za preglednik ili u aplikaciju. Krajnje tačke, parametre i primjere nalaziš u Dokumentaciji za programere. Tamo odjeljak Autentifikacija i opsezi objašnjava šta svako pravo dozvoljava.
- Webhookovi trebaju primaoca s adresom koja počinje sa https://.
Otvaranje API-ja
In STRYKKanali
- Pod Vlastite integracije odaberi red API s dodatkom „API ključevi i webhookovi“. Otvara se dijalog API.
- Odaberi karticu API ključevi ili Webhookovi. Dugmetom Dokumentacija za programere u zaglavlju dijaloga otvaraš portal za programere.
- Kartice API ključevi i Webhookovi
- Ključ s pravima
- Radnje ključa
Kreiranje API ključa
In STRYKKanaliAPIAPI ključevi
- Odaberi Kreiraj API ključ. Otvara se dijalog Kreiraj API ključ.
- Upiši 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 biraš Nema pristupa, Čitanje ili Pisanje. Područja su Hotel i sobe, Dostupnost, 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 Tok rada: Bez isteka, 30 dana, 90 dana, 1 godina ili Datum (od sutra, najviše tri godine unaprijed). Pod IP ograničenje unesi u svaki red jednu adresu ili CIDR mrežu, najviše 20. Ako je prazno, dozvoljene su sve adrese. Pod Bilješka zapiši interni podsjetnik.
- Odaberi Kreiraj. STRYK prikazuje API ključ kreiran s ključem i napomenom Vidljivo samo sada.
- Kopiraj ključ i sačuvaj ga, na primjer, u menadžeru lozinki. Odaberi Gotovo.
Upravljanje ključevima
In STRYKKanaliAPIAPI ključevi
Lista za svaki ključ prikazuje Naziv, početak ključa, Prava, Kreirano, Posljednji put korišteno, Tok rada i status Aktivni, Uskoro ističe, Opozvano ili Istekao. Odaberi ključ da vidiš Prava, Tok rada, Dozvoljene IP adrese, Ograničenje brzine (zahtjeva po minuti), Upotreba, Posljednji zahtjevi i Historija.
- U redu otvori meni Opcije.
- Odaberi Ponovo generiši ako integracija treba novi ključ s istim pravima. Pod Dosadašnji ključ odaberi Stari ključ još 24 h važi, da možeš prebaciti integraciju, ili Opozovi odmah. Potvrdi s Ponovo generiši. STRYK jednom prikazuje novi ključ.
- Odaberi Opozovi i potvrdi Opozvati API ključ?, da ključ odmah blokiraš. STRYK tada odbija zahtjeve s tim ključem.
Postavljanje webhookova
In STRYKKanaliAPIWebhookovi
Webhook šalje odabrane događaje potpisane preko HTTPS-a tvojim sistemima.
- Odaberi Kreiraj webhook. Otvara se dijalog Novi webhook.
- Upiši URL primaoca, na primjer https://crm.nordlicht.invalid/hooks/stryk. Adresa mora početi sa https://.
- Opcionalno: upiši Opis, na primjer „Rezervacije u naš CRM“.
- Pod Događaji odaberi najmanje jedan: Rezervacija kreirana, Rezervacija promijenjena, Rezervacija stornirana, Gost promijenjen, Raspoloživost promijenjena, Cijena promijenjena, Plaćanje promijenjeno ili Status sobe promijenjen. Pomoću Odaberi sve i Poništi odabir biraš sve ili nijedan.
- Odaberi Kreiraj webhook. STRYK jednom prikazuje Tvoja tajna za potpisivanje.
- Tajnu upiši u svoj primalac. Kako primalac provjerava potpis, opisuje dokumentacija za programere u odjeljku Webhookovi i provjera potpisa.
- Odaberi webhook pa Pošalji testni događaj. STRYK javlja „Testni događaj se isporučuje.“
Upravljanje webhookovima
Ort: Kanali > API > Webhookovi, odaberi webhook
- Prekidačem Isporuka aktivna pauziraš ili aktiviraš webhook. Pauzirani webhookovi ne primaju događaje. Nakon aktiviranja isporuka počinje s novim događajima.
- Posljednjih 7 dana, Posljednji uspjeh i Posljednja greška prikazuju stanje. Pod Dostave vidiš svaku dostavu s HTTP status i Pokušaji. Sa Ponovo pošalji ponavljaš dostavu.
- Obnovi tajni ključ generiše novu tajnu. Dosadašnja ostaje važeća još 24 sata, da možeš prebaciti primalac.
- Sa Uredi mijenjaš adresu i događaje, a sa Obriši i potvrdom Obrisati webhook? ga uklanjaš. Dnevnik dostava ostaje sačuvan 30 dana.
Kako provjeriš rezultat
- Kod ključa piše Posljednji put korišteno s datumom čim ga integracija koristi. Zahtjevi 24 h broji zahtjeve.
- Kod webhooka Posljednjih 7 dana prikazuje „{Zahl} isporučeno, {Zahl} neuspješno“, a testni događaj stoji pod Dostave.
Ako nešto ne radi
| Što vidiš | Uzrok | Kako to riješiti |
|---|---|---|
| „Odaberi najmanje jedno pravo.“ | Nijedno područje nema pravo. | Odaberi obrazac ili dodijeli bar 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. Dozvoljeno je najviše 20 unosa. |
| „Odaberi datum od sutra, najviše tri godine unaprijed.“ | Datum isteka je izvan dozvoljenog perioda. | Odaberi datum od sutra koji je najviše tri godine udaljen. |
| „Adresa mora početi sa https://.“ | URL primaoca nije HTTPS adresa. | Unesi adresu s https://. |
| „Odaberi najmanje jedan događaj.“ | Webhook nema nijedan događaj. | Pod Događaji odaberi najmanje jedan. |
| Pauzirano zbog ponovljenih grešaka | Primalac ne odgovara statusom 2xx. | Provjeri je li primalac dostupan i odaberi Ponovo aktiviraj. |
| „Aktiviraj webhook da pošalješ testni događaj.“ | Webhook je pauziran. | Aktiviraj Isporuka aktivna i pošalji testni događaj. |
| „Izbor nije mogao biti učitan. Zatvori ga i ponovo otvori.“ | Lista prava i događaja nije učitana. | Zatvori dijalog i ponovo ga otvori. |