Ireferensi ye-API
Iijongano zabaphuhlisi: iindawo zokungena zikawonke-wonke, iwijethi yencoko, ukungena kunye ne-REST-API ngezitshixo ze-API.
I-API Reference ichaza izidibanisi ze-Zentor App ezinokubizwa kuzo kusuka kwiwebhusayithi nakwinkqubo zenu ngokwazo: iindawo zokungena zikawonke-wonke zeefomu, isilungiselela seemveliso kunye nomxholo, iwijethi yencoko, idemo yechatbot kunye nokungena oquka ukungena kanye. Iphepha ngalinye lendawo yokungena libiza indlela, umendo, ukuqinisekiswa, iimfameta, umzekelo wesicelo nempendulo kunye neekhowudi zempazamo ezibhaliweyo.
Ukuqinisekiswa: iindawo zokungena zeefomu, isilungiselela seemveliso kunye nomxholo zifikeleleka ngaphandle kokungena. Iindawo zokungena zewijethi yencoko zilindele ithokheni yokufaka ye-widget yenu kwisikhundla se-`X-Widget-Token` kwaye zamkele kuphela izicelo ezivela kumadomeyini avunyelweyo ye-widget. Iindawo zokungena zokungena zikhupha ithokheni yokungena (JWT) kunye nethokheni yohlaziyo zeeseshoni zabasebenzisi.
Ukufikelela kwe-API ngesitshixo se-API: kwinkqubo zenu ngokwazo kunye noqhagamshelwano lweseva-nkuseva kufumaneka i-REST-API kwisikhundla sesisekelo seURL `https://zentor-app.de/api/v1`. I-Zentor ivula ufikelelo lwe-API ngesicelo kwi-akhawunti yenu. Emva koko abaphathi badala kwi-dashboard phantsi kuka-„Izitshixo ze-API“ izitshixo zabo kwaye bamise amalungelo abo (scopes) – amadinga nokubhukisha, ichatbot, unxibelelwano, iifayile, isiseko solwazi, iingxelo kunye nedatha yewebhu. Kwicandelo ngalinye, kukho isikhonti sokufunda (`<indawo>.read`, i-GET kuphela) kunye nesikhonti sokubhala (`<indawo>.write`, siquka ukufunda), umzekelo `appointments.read` okanye `knowledge.write`. Thumela isitshixo kwisikhundla se-`Authorization: Bearer <isitshixo se-API>` okanye kwisikhundla esifanelekileyo se-`X-API-Key`. Nge-`GET /api/v1/me` nivavanya ukuba sibhekiselele kwiphi i-akhawunti kunye nezaziphi iiscope isitshixo.
Isitshixo esipheleleyo siboniswa kube kanye kuphela ekudalweni. Sigcine ngokukhuselekileyo kwaye kuphela ngasecaleni kweseva, soloko kukhonjwe kwikhowudi yesikhangeli okanye kwiinkqubo zeselfowuni. Izitshixo zinokufumana umhla wokuphelelwa, zijikeleziswe kwaye zirhoxiswe. Nge-REST-API kufikeleleka kuphela imisebenzi equkiweyo kwipakethi yenu, kwaye yonke idatha ihlala ikhawulelwe kwi-akhawunti yenu. Iimpazamo eziqhelekileyo: 401 `API_KEY_INVALID`, `API_KEY_EXPIRED` okanye `API_KEY_REVOKED` (isitshixo asikho, singasebenziyo, siphelelwe ngamaxesha okanye sirhoxisiwe), 403 `API_ACCESS_NOT_ENABLED` (ufikelelo lwe-API kwi-akhawunti aluvulwa), 403 `API_SCOPE_MISSING` (isitshixo asinayo scope eyimfuneko), 403 `TENANT_NOT_ACTIVE` okanye `TENANT_LOCKED` (iakhawunti ayisebenzi okanye ivalwe) kunye no-404 `API_ENDPOINT_NOT_AVAILABLE` (indawo yokungena ayifumaneki nge-REST-API).
Iimpendulo kunye nemida: zonke iindawo zokungena ziphendula nge-JSON. Impendulo ephumelele ineemo e-2xx kunye no-`"ok": true`; impendulo yempazamo iqulethe ikhowudi yempazamo efundwa yimatshini (kwintsimbi `error` okanye `error.code`) kunye nomyalezo. Nge-IP-dilesi kunokwenziwa izicelo eziyi-2 000 ngaphakathi kwemizuzu eyi-15; iindawo zokungena zeefomu, zokuqinisekiswa nezokungena zinemida engqongqo, ebikwe kwiphepha elifanelekileyo. Ukuba kugqithiselwa, iseva iphendula nge-429 `RATE_LIMIT_EXCEEDED`. Iindawo zokungena ezipheke njengezingezi-idempotent akufuneki ziphindwe ngokuzenzekelayo emva kokuphazamiseka koqhagamshelwano, kuba kungadala izicelo okanye imiyalezo ephindwayo.
Thumela iiphasiwedi, iithokheni, izitshixo ze-API kunye neekhowudi zokuqinisekisa kuphela kumzimba wesicelo okanye kwiiheda nge-HTTPS – hayi kwiiURL, iirekhodi okanye imibuzo yoncedo.