Partner API: Immaniġġja ċ-ċwievet u l-webhooks
Bil-Partner API tqabbad il-paġni tar-riżervi, l-apps u l-integrazzjonijiet tiegħek ma' STRYK. Toħloq ċwievet bid-drittijiet meħtieġa u tissettja webhooks.
Contents
Qabel tibda
- Għandek bżonn id-dritt Immaniġġja l-kanali. Biss b'hekk tara l-linja API fil-paġna Kanali.
- Iċċara liema oqsma l-integrazzjoni trid taqra jew tikteb. Ċavetta tingħata biss dawk id-drittijiet.
- Integrazzjoni ssejjaħ il-Partner API mis-server tagħha. Ċ-ċavetta qatt ma titpoġġa fil-kodiċi tal-browser jew f'app. L-endpoints, il-parametri u l-eżempji jinsabu fid-Dokumentazzjoni għall-iżviluppaturi. Hemm it-taqsima Awtentikazzjoni u scopes tispjega x'jippermetti kull dritt.
- Webhooks jeħtieġu destinatarju b'indirizz li jibda b'https://.
Iftaħ l-API
In STRYKKanali
- Agħżel taħt Konnessjonijiet tiegħek il-linja API bl-aġġunta „Ċwievet API u webhooks“. Id-djalogu API jinfetaħ.
- Agħżel it-tab Ċwievet API jew Webhooks. B'Dokumentazzjoni għall-iżviluppaturi fil-kap tad-djalogu tiftaħ il-portal tal-iżviluppaturi.
- It-tabs Ċwievet API u Webhooks
- Ċwievet bid-drittijiet
- Azzjonijiet taċ-ċavetta
Oħloq ċavetta tal-API
In STRYKKanaliAPIĊwievet API
- Agħżel Oħloq ċavetta tal-API. Id-djalogu Oħloq ċavetta tal-API jinfetaħ.
- Daħħal l-Isem, pereżempju „Paġna tar-riżervi“.
- Agħżel taħt Drittijiet mudell: Qari biss (jaqra l-oqsma kollha), Qari u kitba (jikteb fejn ikun possibbli) jew Personalizzat. Bi Personalizzat tagħżel għal kull qasam Ebda aċċess, Qari jew Kitba. L-oqsma huma Hotel u kmamar, Disponibbiltà, Prezzijiet u tariffi, Riżerviet, Ospiti, Pagamenti u Fatturi. Kitba tinkludi Qari. Il-fatturi huma dokumenti fiskali tal-otel u jistgħu jinqraw biss permezz tal-API.
- Fakultattiv: iftaħ Avvanzat. Agħżel l-Skadenza: Ebda skadenza, 30 jum, 90 jum, 1 sena jew Data (mill-għada, mhux aktar minn tliet snin). Taħt Restrizzjoni tal-IP daħħal f'kull linja indirizz jew netwerk CIDR, sa 20. Vojt jippermetti l-indirizzi kollha. Taħt Nota iżżomm nota interna.
- Agħżel Oħloq. STRYK juri Ċavetta tal-API maħluqa maċ-ċavetta u n-nota Jidher biss issa.
- Ikkopja ċ-ċavetta u aħżinha pereżempju f'manager tal-password. Agħżel Lest.
Immaniġġja ċ-ċwievet
In STRYKKanaliAPIĊwievet API
Il-lista turi għal kull ċavetta l-Isem, il-bidu taċ-ċavetta, id-Drittijiet, Maħluqa, L-aħħar użat, Skadenza u l-istatus: Attiv, Se jiskadi dalwaqt, Revokat jew Skadut. Agħżel ċavetta biex tara d-Drittijiet, is-Skadenza, l-Indirizzi tal-IP permessi, il-Limitu tat-talbiet (talbiet kull minuta), l-Użu, l-L-aħħar talbiet u l-Storja.
- Fil-linja iftaħ il-menu Għażliet.
- Agħżel Ġenera mill-ġdid jekk l-integrazzjoni għandha tirċievi ċavetta ġdida bl-istess drittijiet. Taħt Iċ-ċavetta attwali agħżel Iċ-ċavetta l-qadima għadha valida għal 24 h, biex tkun tista' tibdel l-integrazzjoni, jew Revoka minnufih. Ikkonferma b'Ġenera mill-ġdid. STRYK juri ċ-ċavetta l-ġdida darba.
- Agħżel Revoka u kkonferma Tirrevoka ċ-ċavetta tal-API? biex tblokka ċavetta minnufih. STRYK imbagħad jirrifjuta t-talbiet b'din iċ-ċavetta.
Issettja l-webhooks
In STRYKKanaliAPIWebhooks
Webhook jibgħat l-avvenimenti magħżula, iffirmati, permezz ta' HTTPS lis-sistemi tiegħek.
- Agħżel Oħloq webhook. Id-djalogu Webhook ġdid jinfetaħ.
- Daħħal l-URL tad-destinazzjoni, pereżempju https://crm.nordlicht.invalid/hooks/stryk. L-indirizz irid jibda b'https://.
- Fakultattiv: daħħal Deskrizzjoni, pereżempju „Riżerviet lis-CRM tagħna“.
- Agħżel taħt Avvenimenti mill-inqas wieħed: Riżerva maħluqa, Riżerva aġġornata, Riżerva ikkanċellata, Ospite mibdul, Id-disponibbiltà nbidlet, Il-prezz inbidel, Pagament mibdul jew Status tal-kamra mibdul. B'Agħżel kollox u Neħħi l-għażla tagħżel kollox jew xejn.
- Agħżel Oħloq webhook. STRYK juri Is-sigriet tal-iffirmar tiegħek darba.
- Ħalli s-sigriet fid-destinatarju tiegħek. Kif id-destinatarju jivverifika l-iffirmar tiegħu, jiddeskrivih id-dokumentazzjoni għall-iżviluppaturi taħt Webhooks u verifika tal-iffirmar.
- Agħżel il-webhook u mbagħad Ibgħat avveniment ta' prova. STRYK jgħid „Avveniment ta' prova qed jiġi kkunsinnat.“
Immaniġġja l-webhooks
Ort: Kanali > API > Webhooks, agħżel webhook
- B'il-kmuta Kunsinna attiva tpawża jew tattiva l-webhook. Webhooks mpawżin ma jirċevux avvenimenti. Wara l-attivazzjoni l-kunsinna tibda b'avvenimenti ġodda.
- L-aħħar 7 ijiem, L-aħħar suċċess u L-aħħar żball juru l-istat. Taħt Kunsinni tara kull kunsinna b'Status tal-HTTP u Tentattivi. B'Ibgħat mill-ġdid tirrepeti kunsinna.
- Ibdel is-sigriet joħloq sigriet ġdid. Dak preċedenti jibqa' validu għal 24 siegħa, biex tkun tista' tibdel id-destinatarju.
- B'Editja tibdel l-indirizz u l-avvenimenti, b'Ħassar u l-konferma Thassar il-webhook? titneħħa. Ir-reġistru tal-kunsinni jibqa' 30 jum.
Kif tiċċekkja r-riżultat
- Taċ-ċavetta jidher L-aħħar użat bid-data, hekk kif l-integrazzjoni tużaha. Talbiet 24 h jgħodd it-talbiet.
- Fuq il-webhook L-aħħar 7 ijiem juri „{Zahl} kkunsinnati, {Zahl} falliti“, u l-avveniment ta' prova jidher taħt Kunsinni.
Jekk xi ħaġa ma taħdimx
| Dak li tara | Kawża | Kif issolvih |
|---|---|---|
| „Agħżel mill-inqas dritt wieħed.“ | Ebda qasam m'għandu dritt. | Agħżel mudell jew agħti mill-inqas lil qasam wieħed Qari jew Kitba. |
| „Daħħal isem.“ | L-Isem huwa nieqes. | Daħħal isem. |
| „Iċċekkja:“ segwit mill-indirizz. | Indirizz taħt Restrizzjoni tal-IP mhux validu. | Ikkoreġi l-indirizz jew in-netwerk CIDR. Jiġu permessi sa 20 dħul. |
| „Agħżel data mill-għada, mhux aktar minn tliet snin ’il quddiem.“ | Id-data tal-iskadenza tinsab barra mill-perjodu. | Agħżel data mill-għada li mhix aktar minn tliet snin ’il bogħod. |
| „L-indirizz irid jibda b'https://.“ | L-URL tad-destinazzjoni mhix indirizz HTTPS. | Daħħal indirizz b'https://. |
| „Agħżel mill-inqas avveniment wieħed.“ | Il-webhook m'għandu ebda avveniment. | Agħżel mill-inqas wieħed taħt Avvenimenti. |
| Sospiż minħabba żbalji ripetuti | Id-destinatarju ma jwieġibx b'status 2xx. | Iċċekkja jekk id-destinatarju jkunx jista' jintlaħaq, u agħżel Erġa' attiva. |
| „Attiva l-webhook biex tibgħat avveniment ta' prova.“ | Il-webhook huwa mpawża. | Attiva Kunsinna attiva u ibgħat l-avveniment ta' prova. |
| „L-għażla ma setgħetx titgħabba. Agħlaq u erġa' iftaħ.“ | Il-lista tad-drittijiet u l-avvenimenti ma tgħabbatx. | Agħlaq id-djalogu u erġa' iftaħlu. |