Referenca API

Kjo referencë përshkruan ekskluzivisht endpoint-e JSON reale, të përdorshme publikisht -- metodën, shtegun, llojin e autentifikimit, parametrat e detyrueshëm, shembullin e request-it dhe response-it si dhe kodet e dokumentuara të gabimeve për çdo endpoint. Te Zentor nuk ekziston një sistem i përgjithshëm çelësash API për zhvilluesit; qasja bëhet, në varësi të rrugës, ose pa autentifikim ose përmes një Widget-Embed-Token me kontroll të Origin. Rrugët e brendshme të panelit të kontrollit dhe endpoint-et e Master-Admin qëllimisht nuk janë pjesë e kësaj reference publike, pasi ato arrihen vetëm përmes seancës së rregullt të hyrjes.

Çdo hyrje endpoint-i ka një shënim testi live që tregon nëse informacioni vjen nga skema e Registry-t, nga një test i automatizuar ose nga një vëzhgim real live -- një ngjashmëri e thjeshtë me një shteg kodi që funksionon nuk vlen si provë e plotë. Për më tepër, një thirrje teknikisht e suksesshme konfirmon gjithmonë vetëm përpunimin e vetë request-it përkatës, jo automatikisht proceset pasuese si dorëzimi i emailit, përfundimi i pagesës ose një hyrje SSO e përfunduar.

Siguria varet nga grupi përkatës. Endpoint-et publike ligjore, të marketingut dhe të formularëve nuk kërkojnë seancë në panelin e kontrollit. Widget-i i bisedës, përkundrazi, përdor header-in `X-Widget-Token` dhe një allowlist të Origin. Hyrjet në panelin e kontrollit japin një JWT sesioni me vlefshmëri dymbëdhjetë orë dhe një refresh token me vlefshmëri shtatë ditë. Endpoint-et SSO punojnë me kode të veta njëpërdorimëshe dhe rrjedha callback.

Lexojeni çdo faqe endpoint-i si një kontratë të pavarur. Vendimtare janë metoda HTTP, shtegu, parametrat e detyrueshëm, llojet e të dhënave, trupi i request-it, struktura e response-it, kodet e gabimeve dhe idempotenca. Një shembull tregon një format të mundshëm, por nuk zëvendëson kontrollin e përgjigjes reale. Statusi i konfigurimit, validimet, lejet dhe ofruesit e jashtëm mund ta ndryshojnë rezultatin.

Kufiri i konfirmuar i kërkesave në nivel platforme është 2.000 request-e brenda 15 minutave. Kufij të veçantë për çdo endpoint nuk janë dokumentuar kudo. Prandaj klientët nuk duhet të përdorin cikle polling-u panevojshëm të ngushta. Te operacionet jo-idempotente, përsëritjet automatike mund të krijojnë regjistrime ose mesazhe të dyfishta.

Vlerat e ndjeshme nuk bëjnë pjesë në log-e. Këtu përfshihen fjalëkalimet, token-at e rivendosjes, kodet e verifikimit, token-at e widget-it, ID-të e seancave dhe të dhënat reale personale shembull. Përdorni vlera të anonimizuara në dokumentacion dhe teste. Shënimet e testeve live duhet ta pasqyrojnë saktë provën reale.