Inkomba ye-API

Izixhumanisi zabathuthukisi: izindawo zokungena zomphakathi, iwijethi yengxoxo, ukungena kanye le-REST-API ngezikhiye ze-API.

IAPI Reference ichaza izixhumanisi zeZentor App ezingabizwa kuzo kusuka kuwebhusayithi lezinhlelo zenu uqobo: izindawo zokungena zomphakathi zamafomu, isilungiselela semikhiqizo lokuqukethweyo, iwijethi yengxoxo, idemo yechatbot kanye lokungena okuhlanganisa ukungena kanye. Ikhasi ngalinye lendawo yokungena libiza indlela, umzila, ukuqinisekiswa, amamethrameta, isibonelo sesicelo lempendulo kanye lamakhodi wephutha abhaliweyo.

Ukuqinisekiswa: izindawo zokungena zamafomu, isilungiselela semikhiqizo lokuqukethweyo zifinyeleleka ngaphandle kokungena. Izindawo zokungena zewijethi yengxoxo zilindele ithokheni yokufaka ye-widget yenu esikhundleni se-`X-Widget-Token` njalo zamukela kuphela izicelo ezivela ezigabeni ezivunyelweyo ze-widget. Izindawo zokungena zokungena zikhipha ithokheni yokungena (JWT) lethokheni yokuvuselela zeseshini zabasebenzisi.

Ukufinyelela kwe-API ngesikhiye se-API: ezinhlelweni zenu uqobo lokuxhumana kweseva-kuseva kutholakala i-REST-API esikhundleni sesisekelo se-URL `https://zentor-app.de/api/v1`. IZentor ivula ukufinyelela kwe-API ngesicelo ku-akhawunti yenu. Ngemva kwalokho abaphathi badala ku-dashboard ngaphansi kokuthi „Izikhiye ze-API“ izikhiye zabo njalo banquma amalungelo abo (scopes) – amadinga lokubhuka, ichatbot, ukuxhumana, amafayili, isizinda solwazi, imibiko kanye ledatha yewebhu. Esigabeni ngasinye, kulesizinda sokufunda (`<isizinda>.read`, i-GET kuphela) lesizinda sokubhala (`<isizinda>.write`, sihlanganisa lokufunda), isibonelo `appointments.read` kumbe `knowledge.write`. Thumelani isikhiye esikhundleni se-`Authorization: Bearer <isikhiye se-API>` kumbe esikhundleni esifaneleyo se-`X-API-Key`. Nge-`GET /api/v1/me` lihlola ukuthi siphathiswa kuyiphi i-akhawunti njalo kuwaphi ama-scope isikhiye.

Isikhiye esiphelele sitshengiswa kanye kuphela ekudalweni. Sigcine ngendlela evikelekileyo njalo kuphela ngasohlangothini lweseva, kungabe kubhalwe kukhodi yesikhangeli kumbe ezinhlelweni zeselula. Izikhiye zingathola usuku lokuphela, zijikeleziswe njalo zihoxiswe. Nge-REST-API kufinyeleleka kuphela imisebenzi ehlanganiswe kuphakheji yenu, njalo yonke idatha ihlala ikhawulelwe ku-akhawunti yenu. Amaphutha avamile: 401 `API_KEY_INVALID`, `API_KEY_EXPIRED` kumbe `API_KEY_REVOKED` (isikhiye kasikho, singalungile, siphele isikhathi kumbe sihoxisiwe), 403 `API_ACCESS_NOT_ENABLED` (ukufinyelela kwe-API ku-akhawunti kakuvuliwe), 403 `API_SCOPE_MISSING` (isikhiye kasilayo iscope edingakalayo), 403 `TENANT_NOT_ACTIVE` kumbe `TENANT_LOCKED` (akhawunti kayisebenzi kumbe ivaliwe) kanye lo-404 `API_ENDPOINT_NOT_AVAILABLE` (indawo yokungena kayitholakali nge-REST-API).

Izimpendulo lemikhawulo: zonke izindawo zokungena ziphendula nge-JSON. Impendulo ephumeleleyo ilesimo esiyi-2xx kanye lo-`"ok": true`; impendulo yephutha iqukethe ikhodi yephutha efundwa yimitshina (esimuleni se-`error` kumbe `error.code`) lomlayezo. Nge-IP-adiresi kungenzakala izicelo eziyi-2 000 phakathi kwemizuzu elitshumi lesihlanu; izindawo zokungena zamafomu, zokuqinisekiswa lezokungena kulemikhawulo eqinileyo, ebikwe ekhasini elifaneleyo. Nxa kweqiwa, iseva iphendula nge-429 `RATE_LIMIT_EXCEEDED`. Izindawo zokungena ezimakiweyo njengezingezi-idempotent kakumele ziphindwe ngokuzenzakalela ngemva kokuphazamiseka kokuxhumana, ngoba kungadala izicelo kumbe imilayezo ephindwayo.

Thumelani amaphasiwedi, amathokheni, izikhiye ze-API lamakhodi okuqinisekisa kuphela emzimbeni wesicelo kumbe emaheda nge-HTTPS – kungesi-kuma-URL, amarekhodi kumbe imibuzo yosizo.

Ukuqinisekiswa (5)Ukungena, ukuvuselela ithokheni, ukusetha kutsha iphasiwedi, ukuqedwa kwe-SSO – kanye lokufinyelela kwe-API nge-zikhiye ze-API.Amafomu asedlangalaleni (11)Ukuxhumana, isicelo sokweluleka, isicelo sokufinyelela, ukukhokha kanye lokuvulwa kwe-akhawunti.Isilungiselela semikhiqizo (5)Ikhathalogi yephakheji, ukubukwa kwangaphambili kwenani, ukuqinisekiswa kwe-imeyili lokuthunyelwa kokulungiswa.Okuqukethweyo okusedlangalaleni (6)Imibhalo yomthetho, amakhasi okumaketha, ithimu lemibala yombhalo yewebhusayithi.Iwijethi yengxoxo (9)Zonke izindawo zokungena esisetshenziswa iwijethi yengxoxo efakwe kuwebhusayithi yenu.Idemo ye-chatbot le-SSO (13)Idemo ye-chatbot esedlangalaleni kanye lezindawo zokungena zokungena kanye (SAML/OIDC).
← Emuva kusifinyezo