Referenca API

Ndërfaqe për zhvilluesit: endpointe publike, widget bisede, hyrje dhe REST API me çelësa API.

Referenca API përshkruan ndërfaqet e Zentor App, që mund t'i thërrisni nga faqet dhe programet tuaja: endpointe publike për formularë, konfiguruesin e produktit dhe përmbajtjen, widget-in e bisedës, chatbot-in demo, si dhe hyrjen, duke përfshirë hyrjen e njëhershme (SSO). Faqja e çdo endpoint-i përmend metodën, shtegun, vërtetimin, parametrat, një shembull kërkese dhe përgjigjeje, si dhe kodet e dokumentuara të gabimit.

Vërtetimi: endpointet për formularë, konfiguruesin e produktit dhe përmbajtjen janë të arritshme pa hyrje. Endpointet e widget-it të bisedës presin token-in e ngulitjes së widget-it tuaj në header-in `X-Widget-Token` dhe pranojnë thirrje vetëm nga domenet e miratuara për atë widget. Endpointet e hyrjes lëshojnë për seancat e përdoruesve një token aksesi (JWT) dhe një refresh-token.

Qasje API me çelës API: për programet tuaja dhe lidhjet server-me-server, REST API-ja është e disponueshme në URL-në bazë `https://zentor-app.de/api/v1`. Zentor e aktivizon qasjen API për llogarinë tuaj me kërkesë. Pastaj administratorët krijojnë në panelin e kontrollit, te „Çelësat API“, çelësa të vetë dhe përcaktojnë lejet e tyre (scope) – për takimet dhe rezervimet, chatbot-in, komunikimin, skedarët, bazën e njohurive, raportet dhe të dhënat web. Për çdo fushë ekziston një scope leximi (`<fushë>.read`, vetëm GET) dhe një scope shkrimi (`<fushë>.write`, përfshin leximin), për shembull `appointments.read` ose `knowledge.write`. Dërgoni çelësin në header-in `Authorization: Bearer <çelës API>` ose alternativisht në header-in `X-API-Key`. Me `GET /api/v1/me` kontrolloni se cilës llogari dhe cilave scope i përket një çelës.

Çelësi i plotë shfaqet vetëm një herë, në momentin e krijimit. Ruajeni të sigurt dhe ekskluzivisht në anën e serverit, kurrë në kodin e shfletuesit ose në aplikacionet mobile. Çelësat mund të marrin një datë skadimi, të rrotullohen dhe të anulohen. Përmes REST API-së janë të arritshme vetëm funksionet e përfshira në paketën tuaj, dhe të gjitha të dhënat janë të kufizuara në llogarinë tuaj. Gabime tipike: 401 `API_KEY_INVALID`, `API_KEY_EXPIRED` ose `API_KEY_REVOKED` (çelësi mungon, është i gabuar, i skaduar ose i anuluar), 403 `API_ACCESS_NOT_ENABLED` (qasja API nuk është aktivizuar për llogarinë), 403 `API_SCOPE_MISSING` (çelësit i mungon scope-i i nevojshëm), 403 `TENANT_NOT_ACTIVE` ose `TENANT_LOCKED` (llogaria nuk është aktive ose është e bllokuar) dhe 404 `API_ENDPOINT_NOT_AVAILABLE` (endpoint-i nuk është i disponueshëm përmes REST API-së).

Përgjigjet dhe kufijtë: të gjitha endpointet përgjigjen në format JSON. Një përgjigje e suksesshme ka statusin 2xx dhe `"ok": true`; një përgjigje gabimi përmban një kod gabimi të lexueshëm nga makina (në fushën `error` ose `error.code`) dhe një mesazh. Për çdo adresë IP janë të mundshme 2000 kërkesa brenda 15 minutave; për endpointet e formularëve, konfirmimit dhe hyrjes zbatohen kufij më të rreptë, të përmendur në faqen përkatëse. Në rast tejkalimi, serveri përgjigjet me 429 `RATE_LIMIT_EXCEEDED`. Endpointet e shënuara si jo-idempotente nuk duhet të përsëriten automatikisht pas një ndërprerjeje lidhjeje, pasi kjo mund të krijojë kërkesa ose mesazhe të dyfishuara.

Transmetoni fjalëkalimet, token-et, çelësat API dhe kodet e konfirmimit vetëm në trupin e kërkesës ose në header-a mbi HTTPS – kurrë në URL, regjistra ose kërkesa mbështetjeje.

Vërtetimi (5)Hyrja, rinovimi i token-it, rivendosja e fjalëkalimit, përfundimi i SSO – dhe qasja API me çelës API.Formularët publikë (11)Kontakti, kërkesa për konsultim, kërkesa për qasje, pagesa dhe aktivizimi i llogarisë.Konfiguruesi i produktit (5)Katalogu i paketave, parashikimi i çmimit, konfirmimi i e-mailit dhe dorëzimi i konfigurimit.Përmbajtje publike (6)Tekstet ligjore, faqet e marketingut, tema dhe ngjyrat e tekstit të faqes.Widget-i i bisedës (9)Të gjitha endpoint-et që përdor widget-i i integruar i bisedës në faqen tuaj.Demo-chatbot dhe SSO (13)Demo-chatbot-i publik dhe endpoint-et për identifikim të njëhershëm (SAML/OIDC).
← Kthehu te pasqyra