Inkomba ye-API

Izixhumi zabathuthukisi: izindawo zokungena zomphakathi, iwijethi yengxoxo, ukungena kanye ne-REST-API ngokhiye be-API.

I-API Reference ichaza izixhumi ze-Zentor App enokubizwa kuzo kusuka ewebhusayithi nohlelweni lwenu uqobo: izindawo zokungena zomphakathi zamafomu, isilungiselela semikhiqizo nokuqukethwe, iwijethi yengxoxo, idemo ye-chatbot kanye nokungena okuhlanganise ukungena kanye. Ikhasi ngalinye lendawo yokungena libiza indlela, umzila, ukuqinisekiswa, amamethrameta, isibonelo sesicelo nempendulo kanye namakhodi wephutha abhaliwe.

Ukuqinisekiswa: izindawo zokungena zamafomu, isilungiselela semikhiqizo nokuqukethwe zifinyeleleka ngaphandle kokungena. Izindawo zokungena zewijethi yengxoxo zilindele ithokheni yokufaka ye-widget yenu esikhundleni se-`X-Widget-Token` futhi zamukele kuphela izicelo ezivela ezizindeni ezivunyelwe ze-widget. Izindawo zokungena zokungena zikhipha ithokheni yokungena (JWT) nethokheni yokuvuselela zamaseshini abasebenzisi.

Ukufinyelela kwe-API ngokhiye be-API: kuzinhlelo zenu uqobo nokuxhumana kweseva-kuseva kutholakala i-REST-API kusikhundla sesisekelo se-URL `https://zentor-app.de/api/v1`. I-Zentor ivula ukufinyelela kwe-API ngesicelo ku-akhawunti yenu. Ngemva kwalokho abaphathi badala ku-dashboard ngaphansi kokuthi „Okhiye be-API“ okhiye babo futhi banquma amalungelo abo (scopes) – amaphoyintimenti nokubhuka, i-chatbot, ukuxhumana, amafayela, isizinda solwazi, imibiko kanye nedatha yewebhu. Esigabeni ngasinye, kunesizinda sokufunda (`<isizinda>.read`, i-GET kuphela) nesizinda sokubhala (`<isizinda>.write`, sihlanganise nokufunda), isibonelo `appointments.read` noma `knowledge.write`. Thumela ukhiye esikhundleni se-`Authorization: Bearer <okhiye be-API>` noma esikhundleni esifanele se-`X-API-Key`. Nge-`GET /api/v1/me` nihlola ukuthi uphatheke kuyiphi i-akhawunti futhi kuwaphi ama-scope ukhiye.

Ukhiye ophelele uboniswa kanye kuphela ngesikhathi sokudalwa. Wugcine uphephile futhi uqobo kuseva, akusho ngqo kukhodi yesiphequluli noma izinhlelo zeselula. Okhiye bangathola usuku lokuphelelwa, bajikeleziswe futhi bahoxiswe. Nge-REST-API kufinyeleleka kuphela imisebenzi equkwe ephaketheni lenu, futhi yonke idatha ihlala ikhawulelwe ku-akhawunti yenu. Amaphutha avamile: 401 `API_KEY_INVALID`, `API_KEY_EXPIRED` noma `API_KEY_REVOKED` (ukhiye angekho, uyiphutha, uphelelwe isikhathi noma uhoxisiwe), 403 `API_ACCESS_NOT_ENABLED` (ukufinyelela kwe-API ku-akhawunti akavulwanga), 403 `API_SCOPE_MISSING` (ukhiye wentula i-scope edingekayo), 403 `TENANT_NOT_ACTIVE` noma `TENANT_LOCKED` (akhawunti ayisebenzi noma ivaliwe) kanye no-404 `API_ENDPOINT_NOT_AVAILABLE` (indawo yokungena ayitholakali nge-REST-API).

Izimpendulo nemikhawulo: zonke izindawo zokungena ziphendula nge-JSON. Impendulo ephumelele inesimo esiyi-2xx kanye no-`"ok": true`; impendulo yephutha iqukethe ikhodi yephutha efundwa ngumshini (esimuleni se-`error` noma `error.code`) nomlayezo. Nge-IP-adrese kungenziwa izicelo eziyi-2 000 phakathi kwemizuzu eli-15; izindawo zokungena zamafomu, zokuqinisekiswa nezokungena kunemikhawulo eqinile, ebikwe ekhasini elifanele. Uma kweqiwa, iseva iphendula nge-429 `RATE_LIMIT_EXCEEDED`. Izindawo zokungena ezimakwe njengezingezi-idempotent akufanele ziphindwe ngokuzenzakalela ngemva kokuphazamiseka kokuxhumana, ngoba kungadala izicelo noma imiyalezo eziphindwayo.

Thumela amaphasiwedi, amathokheni, okhiye be-API namakhodi okuqinisekisa kuphela emzimbeni wesicelo noma emaheda nge-HTTPS – hhayi kuma-URL, amarekhodi noma imibuzo yosizo.

Ukuqinisekiswa (5)Ukungena, ukuvuselela ithokheni, ukusetha kabusha iphasiwedi, ukuqedwa kwe-SSO – kanye nokufinyelela kwe-API nge-okhiye be-API.Amafomu asesidlangalaleni (11)Ukuxhumana, isicelo sokweluleka, isicelo sokufinyelela, inkokhelo kanye nokuvulwa kwe-akhawunti.Isilungiselela semikhiqizo (5)Ikhathalogi yephakethe, ukubukwa kwangaphambili kwenani, ukuqinisekiswa kwe-imeyili nokuthunyelwa kokulungiselelwa.Okuqukethwe okusesidlangalaleni (6)Imibhalo yomthetho, amakhasi okumaketa, itimu namabala ombhalo wewebhusayithi.Iwijethi yengxoxo (9)Zonke izindawo zokungena esisetshenziswa iwijethi yengxoxo efakwe kuwebhusayithi yenu.Idemo ye-chatbot ne-SSO (13)Idemo ye-chatbot esesidlangalaleni kanye nezindawo zokungena zokungena kanye (SAML/OIDC).
← Buyela kuhlolojikelele