Partner API: menaxho çelësat dhe webhook-et
Me Partner API lidh faqet e tua të rezervimit, aplikacionet dhe integrimet me STRYK. Krijon çelësa me të drejtat e nevojshme dhe konfiguron webhook-et.
Contents
Para se të fillosh
- Të duhet e drejta Menaxho kanalet. Vetëm kështu e sheh rreshtin API në faqen Kanalet.
- Sqaro cilat zona integrimi duhet t'i lexojë ose t'i shkruajë. Një çelës merr vetëm këto të drejta.
- Një integrim e thërret Partner API nga serveri i tij. Çelësin nuk e vendos kurrë në kodin e shfletuesit ose në një aplikacion. Endpoint-et, parametrat dhe shembujt i gjen në Dokumentacioni për zhvilluesit. Atje seksioni Autentifikimi dhe scope-et shpjegon çfarë lejon çdo e drejtë.
- Webhook-et kanë nevojë për një marrës me adresë që fillon me https://.
Hap API-n
In STRYKKanalet
- Te Lidhjet e tua zgjedh rreshtin API me shtesën „Çelësat API dhe webhook-et“. Hapet dialogu API.
- Zgjedh tabin API-Schlüssel ose Webhooks. Me Dokumentacioni për zhvilluesit në kokën e dialogut hap portalin e zhvilluesve.
- Tabet Çelësat API dhe Webhooks
- Çelësa me të drejta
- Veprimet e çelësit
Krijo një çelës API
In STRYKKanaletAPIÇelësat API
- Zgjedh Krijo çelës API. Hapet dialogu Krijo çelës API.
- Plotëso Emri, për shembull „Faqja e rezervimit“.
- Zgjedh te Të drejtat një model: Vetëm lexim (lexon të gjitha zonat), Lexim & shkrim (shkruan aty ku është e mundur) ose Të personalizuar. Te Të personalizuar zgjedh për çdo zonë Pa qasje, Lexim ose Shkrim. Zonat janë Hoteli & dhomat, Disponueshmëria, Çmimet & tarifat, Rezervimet, Mysafirët, Pagesat dhe Faturat. Shkrim përfshin Lexim. Faturat janë dokumente fiskale të hotelit dhe mund të lexohen vetëm me API.
- Opsionale: hap Të avancuar. Zgjedh Skadimi: Pa skadim, 30 ditë, 90 ditë, 1 vit ose Data (nga nesër, për maksimumi tre vjet). Te Kufizimi i IP-së shkruan në çdo rresht një adresë ose rrjet CIDR, deri në 20. Bosh do të thotë se lejohen të gjitha adresat. Te Shënim mban një shënim të brendshëm.
- Zgjedh Krijo. STRYK tregon Çelësi API u krijua me çelësin dhe shënimin Të dukshëm vetëm tani.
- Kopjo çelësin dhe ruaje për shembull në menaxherin e fjalëkalimeve. Zgjedh Gati.
Menaxho çelësat
In STRYKKanaletAPIÇelësat API
Lista tregon për çdo çelës Emri, fillimin e çelësit, Të drejtat, Krijuar, Përdorur për herë të fundit, Skadimi dhe statusin: Aktiv, Skadon së shpejti, Revokuar ose Skaduar. Zgjedh një çelës për të parë Të drejtat, Skadimi, Adresat IP të lejuara, Kufiri i shpejtësisë (kërkesa në minutë), Përdorimi, Kërkesat e fundit dhe Historiku.
- Hap në rresht menynë Opsionet.
- Zgjedh Rigjenero nëse integrimi duhet të marrë një çelës të ri me të njëjtat të drejta. Te Çelësi aktual zgjedh Çelësi i vjetër vlen edhe 24 orë, që të mund ta ndryshosh integrimin, ose Revoko menjëherë. Konfirmo me Rigjenero. STRYK e tregon çelësin e ri vetëm një herë.
- Zgjedh Revoko dhe konfirmo Të revokohet çelësi API?, për ta bllokuar menjëherë një çelës. Kërkesat me këtë çelës STRYK i refuzon atëherë.
Konfiguro webhook-et
In STRYKKanaletAPIWebhooks
Një webhook dërgon ngjarjet e zgjedhura të nënshkruara me HTTPS te sistemet e tua.
- Zgjedh Krijo webhook. Hapet dialogu Webhook i ri.
- Plotëso URL e marrësit, për shembull https://crm.nordlicht.invalid/hooks/stryk. Adresa duhet të fillojë me https://.
- Opsionale: plotëso Përshkrimi, për shembull „Rezervimet te CRM-ja jonë“.
- Zgjedh te Ngjarje të paktën një: Rezervimi u krijua, Rezervimi u ndryshua, Rezervimi u anulua, Mysafiri u ndryshua, Disponueshmëria u ndryshua, Çmimi u ndryshua, Pagesa u ndryshua ose Statusi i dhomës u ndryshua. Me Zgjidh të gjitha dhe Hiq zgjedhjen zgjedh të gjitha ose asnjërën.
- Zgjedh Krijo webhook. STRYK tregon Sekreti yt i nënshkrimit vetëm një herë.
- Ruaje sekretin në marrësin tënd. Si e kontrollon marrësi nënshkrimin, e përshkruan dokumentacioni për zhvilluesit te Webhook-et dhe kontrolli i nënshkrimit.
- Zgjedh webhook-un dhe më pas Dërgo ngjarje testi. STRYK tregon „Ngjarja e testit po dërgohet.“
Menaxho webhook-et
Ort: Kanalet > API > Webhook-et, zgjidh webhook-un
- Me çelësin Dërgimi aktiv pauzon ose aktivizon webhook-un. Webhook-et e pauzuara nuk marrin ngjarje. Pas aktivizimit dërgimi fillon me ngjarjet e reja.
- 7 ditët e fundit, Suksesi i fundit dhe Gabimi i fundit tregojnë gjendjen. Te Dërgesat sheh çdo dërgim me Statusi HTTP dhe Përpjekjet. Me Dërgo përsëri e përsërit një dërgim.
- Rinovo sekretin krijon një sekret të ri. I mëparshmi mbetet i vlefshëm edhe 24 orë, që të mund ta ndryshosh marrësin.
- Me Redakto ndryshon adresën dhe ngjarjet, me Fshi dhe konfirmimin Të fshihet webhook-u? e heq. Protokolli i dërgimit ruhet 30 ditë.
Si e kontrollon rezultatin
- Te çelësi shfaqet Përdorur për herë të fundit me datën, sapo integrimi e përdor. Kërkesat 24 orë i numëron kërkesat.
- Te webhook-u 7 ditët e fundit shfaq „{Zahl} të dërguara, {Zahl} të dështuara“, dhe ngjarja e testit shfaqet te Dërgesat.
Nëse diçka nuk funksionon
| Çfarë shikon | Shkaku | Si e zgjidh |
|---|---|---|
| „Zgjidh të paktën një të drejtë.“ | Asnjë zonë nuk ka të drejtë. | Zgjedh një model ose i jep të paktën një zone Lexim ose Shkrim. |
| „Shkruaj një emër.“ | Emri mungon. | Plotëso një emër. |
| „Kontrollo:“ me një adresë | Një adresë te Kufizimi i IP-së është e pavlefshme. | Korrigjo adresën ose rrjetin CIDR. Lejohen deri në 20 hyrje. |
| „Zgjidh një datë nga nesër, për maksimumi tre vjet.“ | Data e skadimit është jashtë intervalit. | Zgjidh një datë nga nesër, jo më larg se tre vjet. |
| „Adresa duhet të fillojë me https://.“ | URL e marrësit nuk është adresë HTTPS. | Shkruaj një adresë me https://. |
| „Zgjidh të paktën një ngjarje.“ | Webhook-u nuk ka asnjë ngjarje. | Zgjidh të paktën një te Ngjarje. |
| Në pauzë për shkak gabimesh të përsëritura | Marrësi nuk përgjigjet me statusin 2xx. | Kontrollo nëse marrësi është i arritshëm dhe zgjedh Aktivizo përsëri. |
| „Aktivizo webhook-un për të dërguar një ngjarje testi.“ | Webhook-u është në pauzë. | Aktivizo Dërgimi aktiv dhe dërgo ngjarjen e testit. |
| „Zgjedhja nuk u ngarkua. Mbyll dhe hape sërish.“ | Lista e të drejtave dhe ngjarjeve nuk u ngarkua. | Mbyll dialogun dhe hape sërish. |