Partner API: upravljanje ključevima i webhookovima
Sa Partner API povezuješ sopstvene stranice za rezervacije, aplikacije i integracije sa STRYK-om. Praviš ključeve sa tačno potrebnim pravima i podešavaš webhookove.
Contents
Pre nego što počneš
- Potrebno ti je pravo Upravljanje kanalima. Tek sa njim vidiš red API na stranici Kanali.
- Razjasni koja područja integracija mora da čita ili upisuje. Ključ dobija samo ta prava.
- Integracija poziva Partner API sa svog servera. Ključ nikada ne stavljaš u kod pregledača ili u aplikaciju. Krajnje tačke, parametri i primeri nalaze se u Dokumentaciji za programere. Odeljak Autentifikacija i opsezi objašnjava šta svako pravo dozvoljava.
- Webhookovi zahtevaju primaoca sa adresom koja počinje sa https://.
Otvori API
In STRYKKanali
- Izaberi pod Sopstvene veze red API sa dodatkom „API ključevi i webhookovi“. Otvara se dijalog API.
- Izaberi karticu API ključevi ili Webhookovi. Sa Dokumentacija za programere u zaglavlju dijaloga otvaraš portal za programere.
- Kartice API ključevi i Webhookovi
- Ključevi sa pravima
- Radnje ključa
Napravi API ključ
In STRYKKanaliAPIAPI ključevi
- Izaberi Napravi API ključ. Otvara se dijalog Napravi API ključ.
- Unesi Naziv, na primer „Stranica za rezervacije“.
- Pod Prava izaberi obrazac: Samo čitanje (čitanje svih područja), Čitanje i pisanje (pisanje gde je moguće) ili Prilagođeno. Kod Prilagođeno za svako područje biraš Bez pristupa, Čitanje ili Pisanje. Područja su Hotel i sobe, Raspoloživost, Cene i tarife, Rezervacije, Gosti, Plaćanja i Fakture. Pisanje obuhvata Čitanje. Fakture su fiskalni dokumenti hotela i preko API-ja se mogu samo čitati.
- Opciono: otvori Napredno. Izaberi Rok isteka: Bez isteka, 30 dana, 90 dana, 1 godina ili Datum (od sutra, najviše tri godine unapred). Unesi pod IP ograničenje po redu adresu ili CIDR mrežu, najviše 20. Prazno dozvoljava sve adrese. Pod Beleška upisuješ interni podsetnik.
- Izaberi Napravi. STRYK prikazuje API ključ napravljen sa ključem i napomenom Vidljivo samo sada.
- Kopiraj ključ i sačuvaj ga, na primer u menadžeru lozinki. Izaberi Gotovo.
Upravljanje ključevima
In STRYKKanaliAPIAPI ključevi
Lista za svaki ključ prikazuje Naziv, početak ključa, Prava, Kreirano, Poslednje korišćeno, Rok isteka i status: Aktivni, Uskoro ističe, Opozvano ili Istekao. Izaberi ključ da vidiš Prava, Rok isteka, Dozvoljene IP adrese, Ograničenje zahteva (zahteva u minuti), Korišćenje, Poslednji zahtevi i odeljak Istorija.
- U redu otvori meni Opcije.
- Izaberi Ponovo generiši ako integracija treba da dobije novi ključ sa istim pravima. Pod Dosadašnji ključ izaberi Stari ključ još 24 h važi da bi prebacio integraciju, ili Odmah opozovi. Potvrdi sa Ponovo generiši. STRYK prikazuje novi ključ jednom.
- Izaberi Opozovi i potvrdi Opozvati API ključ? da odmah blokiraš ključ. STRYK tada odbija zahteve sa ovim ključem.
Podesi webhookove
In STRYKKanaliAPIWebhookovi
Webhook šalje izabrane događaje potpisane preko HTTPS-a na tvoje sisteme.
- Izaberi Napravi webhook. Otvara se dijalog Novi webhook.
- Unesi URL primaoca, na primer https://crm.nordlicht.invalid/hooks/stryk. Adresa mora početi sa https://.
- Opciono: unesi Opis, na primer „Rezervacije za naš CRM“.
- Izaberi pod Događaji najmanje jedan: Rezervacija kreirana, Rezervacija izmenjena, Rezervacija stornirana, Gost promenjen, Raspoloživost promenjena, Cena promenjena, Plaćanje promenjeno ili Status sobe promenjen. Sa Izaberi sve i Poništi izbor biraš sve ili nijedan.
- Izaberi Napravi webhook. STRYK prikazuje Tvoja tajna za potpisivanje jednom.
- Sačuvaj tajnu u svom primaocu. Dokumentacija za programere u odeljku Webhookovi i provera potpisa objašnjava kako primalac proverava potpis.
- Izaberi webhook i zatim Pošalji probni događaj. STRYK javlja „Probni događaj se isporučuje.“
Upravljanje webhookovima
Ort: Kanali > API > Webhookovi, izaberi webhook
- Sa prekidačem Isporuka aktivna pauziraš ili aktiviraš webhook. Pauzirani webhookovi ne primaju događaje. Nakon aktiviranja isporuka počinje sa novim događajima.
- Poslednjih 7 dana, Poslednji uspeh i Poslednja greška prikazuju stanje. Pod Isporuke vidiš svaku isporuku sa HTTP status i Pokušaji. Sa Pošalji ponovo ponavljaš isporuku.
- Obnovi tajni ključ pravi novu tajnu. Dosadašnja ostaje važeća još 24 sata da bi mogao da prebaciš primaoca.
- Sa Uredi menjaš adresu i događaje, sa Obriši i potvrdom Obrisati webhook? ga uklanjaš. Protokol isporuka ostaje sačuvan 30 dana.
Kako proveravaš rezultat
- Kod ključa piše Poslednje korišćeno sa datumom čim ga integracija upotrebi. Zahtevi 24 h broji zahteve.
- Kod webhooka Poslednjih 7 dana prikazuje „{Zahl} isporučeno, {Zahl} neuspelo“, a probni događaj stoji pod Isporuke.
Ako nešto ne radi
| Šta vidiš | Uzrok | Kako to rešavaš |
|---|---|---|
| „Izaberi najmanje jedno pravo.“ | Nijedno područje nema pravo. | Izaberi obrazac ili daj najmanje jednom području Čitanje ili Pisanje. |
| „Unesi naziv.“ | Naziv nedostaje. | Unesi naziv. |
| „Proveri:“ sa adresom | Jedna adresa u IP ograničenje nije ispravna. | Ispravi adresu ili CIDR mrežu. Dozvoljeno je najviše 20 unosa. |
| „Unesi datum od sutra, najviše tri godine unapred.“ | Datum isteka je van dozvoljenog perioda. | Izaberi datum od sutra koji je najviše tri godine unapred. |
| „Adresa mora početi sa https://.“ | URL primaoca nije HTTPS adresa. | Unesi adresu sa https://. |
| „Izaberi najmanje jedan događaj.“ | Webhook nema nijedan događaj. | Izaberi pod Događaji najmanje jedan. |
| Pauzirano zbog ponovljenih grešaka | Primalac ne odgovara sa statusom 2xx. | Proveri da li je primalac dostupan i izaberi Ponovo aktiviraj. |
| „Aktiviraj webhook da bi poslao probni događaj.“ | Webhook je pauziran. | Aktiviraj Isporuka aktivna i pošalji probni događaj. |
| „Izbor nije mogao da se učita. Zatvori i ponovo otvori.“ | Lista prava i događaja nije učitana. | Zatvori dijalog i ponovo ga otvori. |