Partner API: atslēgu un webhook pārvaldība
Ar Partner API savieno savas rezervēšanas lapas, lietotnes un integrācijas ar STRYK. Izveido atslēgas ar tieši vajadzīgajām tiesībām un iestati webhook.
Contents
Pirms sāc
- Vajadzīga tiesība Pārvaldīt kanālus. Tikai tad redzi rindu API lapā Kanāli.
- Noskaidro, kuras jomas integrācijai jālasa vai jāraksta. Atslēga saņem tikai tās tiesības.
- Integrācija izsauc Partner API no sava servera. Atslēgu nekad neievieto pārlūkprogrammas kodā vai lietotnē. Galapunktus, parametrus un piemērus atrodi Izstrādātāju dokumentācijā. Tur sadaļa Autentifikācija un tvērumi paskaidro, ko katra tiesība atļauj.
- Webhook saņēmējam vajag adresi, kas sākas ar https://.
Atver API
In STRYKKanāli
- Sadaļā Savi savienojumi izvēlies rindu API ar piebildi „API atslēgas un webhook“. Atveras dialogs API.
- Izvēlies cilni API atslēgas vai Webhooks. Ar Izstrādātāju dokumentācija dialoga galvenē atver izstrādātāju portālu.
- Cilnes API atslēgas un Webhooks
- Atslēga ar tiesībām
- Atslēgas darbības
API atslēgas izveide
In STRYKKanāliAPIAPI atslēgas
- Izvēlies Izveidot API atslēgu. Atveras dialogs Izveidot API atslēgu.
- Ieraksti Nosaukums, piemēram, „Rezervēšanas lapa“.
- Laukā Tiesības izvēlies modeli: Tikai lasīt (lasīt visas jomas), Lasīt un rakstīt (rakstīt, kur tas iespējams) vai Pielāgots. Pie Pielāgots katrai jomai izvēlies Nav piekļuves, Lasīt vai Rakstīt. Jomas ir Viesnīca un numuri, Pieejamība, Cenas un tarifi, Rezervācijas, Viesi, Maksājumi un Rēķini. Rakstīt ietver Lasīt. Rēķini ir viesnīcas fiskālie dokumenti, tos caur API var tikai lasīt.
- Pēc izvēles: atver Paplašināts. Laukā Derīguma termiņš izvēlies Bez derīguma termiņa, 30 dienas, 90 dienas, 1 gads vai Datums (sākot ar rītdienu, ne vairāk kā trīs gadus uz priekšu). Laukā IP ierobežojums katrā rindā ieraksti vienu adresi vai CIDR tīklu, ne vairāk kā 20. Tukšs lauks atļauj visas adreses. Laukā Piezīme ieraksti iekšēju norādi.
- Izvēlies Izveidot. STRYK rāda API atslēga izveidota ar atslēgu un norādi Redzams tikai tagad.
- Nokopē atslēgu un saglabā to, piemēram, paroļu pārvaldniekā. Izvēlies Gatavs.
Atslēgu pārvaldība
In STRYKKanāliAPIAPI atslēgas
Sarakstā katrai atslēgai redzams Nosaukums, atslēgas sākums, Tiesības, Izveidots, Pēdējo reizi lietots, Derīguma termiņš un statuss: Aktīvs, Drīz beigsies, Atsaukts vai Beidzies. Izvēlies atslēgu, lai redzētu Tiesības, Derīguma termiņš, Atļautās IP adreses, Pieprasījumu limits (pieprasījumi minūtē), Lietojums, Pēdējie pieprasījumi un Vēsture.
- Atver rindā izvēlni Opcijas.
- Izvēlies Pārģenerēt, ja integrācijai vajag jaunu atslēgu ar tādām pašām tiesībām. Zem Esošā atslēga izvēlies Vecā atslēga vēl 24 h derīga, lai varētu pārslēgt integrāciju, vai Atsaukt nekavējoties. Apstiprini ar Pārģenerēt. STRYK rāda jauno atslēgu vienreiz.
- Izvēlies Atsaukt un apstiprini Atsaukt API atslēgu?, lai nekavējoties bloķētu atslēgu. STRYK tad noraida pieprasījumus ar šo atslēgu.
Webhook iestatīšana
In STRYKKanāliAPIWebhooks
Webhook nosūta izvēlētos notikumus parakstītus pa HTTPS uz tavām sistēmām.
- Izvēlies Izveidot webhook. Atveras dialogs Jauns webhook.
- Ieraksti Saņēmēja URL, piemēram, https://crm.nordlicht.invalid/hooks/stryk. Adresei jāsākas ar https://.
- Pēc izvēles: ieraksti Apraksts, piemēram, „Rezervācijas uz mūsu CRM“.
- Laukā Notikumi izvēlies vismaz vienu: Rezervācija izveidota, Rezervācija mainīta, Rezervācija atcelta, Viesis mainīts, Pieejamība mainīta, Cena mainīta, Maksājums mainīts vai Numura statuss mainīts. Ar Izvēlēties visus un Noņemt atlasi izvēlies visus vai nevienu.
- Izvēlies Izveidot webhook. STRYK rāda Tavs parakstīšanas noslēpums vienreiz.
- Ieraksti noslēpumu savā saņēmējā. Kā saņēmējam pārbaudīt parakstu, apraksta izstrādātāju dokumentācija sadaļā Webhook un parakstu pārbaude.
- Izvēlies webhook un tad Sūtīt testa notikumu. STRYK paziņo „Testa notikums tiek piegādāts.“
Webhook pārvaldība
Ort: Kanāli > API > Webhooks, izvēlies webhook
- Ar slēdzi Piegāde aktīva tu aptur vai aktivizē webhook. Apturēti webhook nesaņem notikumus. Pēc aktivizēšanas piegāde sākas ar jauniem notikumiem.
- Pēdējās 7 dienas, Pēdējais veiksmīgais un Pēdējā kļūda rāda stāvokli. Zem Piegādes redzi katru piegādi ar HTTP statuss un Mēģinājumi. Ar Sūtīt atkārtoti atkārto piegādi.
- Atjaunot noslēpumu izveido jaunu noslēpumu. Iepriekšējais paliek derīgs vēl 24 stundas, lai varētu pārslēgt saņēmēju.
- Ar Rediģēt maini adresi un notikumus, ar Dzēst un apstiprinājumu Dzēst webhook? noņem to. Piegādes žurnāls saglabājas 30 dienas.
Kā pārbaudīt rezultātu
- Pie atslēgas redzams Pēdējo reizi lietots ar datumu, tiklīdz integrācija to izmanto. Pieprasījumi 24 h skaita pieprasījumus.
- Pie webhook Pēdējās 7 dienas rāda „{Zahl} piegādāti, {Zahl} neizdevās“, un testa notikums ir redzams zem Piegādes.
Ja kaut kas nedarbojas
| Ko redzi | Cēlonis | Kā to novērst |
|---|---|---|
| „Izvēlies vismaz vienu tiesību.“ | Neviena joma nav ar tiesību. | Izvēlies modeli vai piešķir vismaz vienai jomai Lasīt vai Rakstīt. |
| „Ievadi nosaukumu.“ | Trūkst Nosaukums. | Ieraksti nosaukumu. |
| „Pārbaudi:“ ar adresi | Viena adrese laukā IP ierobežojums ir nederīga. | Izlabo adresi vai CIDR tīklu. Atļauti ir ne vairāk kā 20 ieraksti. |
| „Izvēlies datumu sākot ar rītdienu, ne vairāk kā trīs gadus uz priekšu.“ | Derīguma termiņa datums ir ārpus atļautā laika. | Izvēlies datumu sākot ar rītdienu, kas ir ne tālāk par trim gadiem. |
| „Adresei jāsākas ar https://.“ | Saņēmēja URL nav HTTPS adrese. | Ieraksti adresi ar https://. |
| „Izvēlies vismaz vienu notikumu.“ | Webhookam nav neviena notikuma. | Laukā Notikumi izvēlies vismaz vienu. |
| Apturēts atkārtotu kļūdu dēļ | Saņēmējs neatbild ar 2xx statusu. | Pārbaudi, vai saņēmējs ir sasniedzams, un izvēlies Aktivizēt vēlreiz. |
| „Aktivizē webhook, lai sūtītu testa notikumu.“ | Webhook ir apturēts. | Aktivizē Piegāde aktīva un sūti testa notikumu. |
| „Sarakstu nevarēja ielādēt. Aizver un atver to vēlreiz.“ | Tiesību un notikumu saraksts nav ielādēts. | Aizver dialogu un atver to vēlreiz. |