Inkomba ye-API

Le nkomba ichaza kuphela ama-endpoint e-JSON angempela asetshenziswa esidlangalaleni -- i-method, i-path, uhlobo lokuqinisekisa ubunikazi, amapharamitha ayimpoqo, isibonelo se-request nese-response kanye namakhodi amaphutha abhaliwe nge-endpoint ngayinye. I-Zentor ayinayo isistimu ejwayelekile yokhiye be-API bonjiniyela; ngokuya ngomzila, ukufinyelela kwenzeka ngaphandle kokuqinisekisa ubunikazi noma nge-widget embed token enokuhlolwa kwe-origin. Imizila yangaphakathi yedashibhodi nama-endpoint e-Master-Admin ngamabomu akuyona ingxenye yale nkomba yomphakathi, ngoba afinyeleleka kuphela ngeseshini evamile yokungena.

Okufakiwe kwe-endpoint ngakunye kunenothi lokuhlolwa bukhoma elidalula ukuthi imininingwane ivela ku-registry schema, ekuhlolweni okuzenzakalelayo noma ekubhekweni kwangempela bukhoma -- ukufana nje nendlela yekhodi esebenzayo akuthathwa njengobufakazi obuphelele. Ukubiza okuphumelele ngokobuchwepheshe kuhlale kuqinisekisa kuphela ukucutshungulwa kwe-request ethile uqobo, hhayi ngokuzenzakalela izinqubo ezilandelayo ezifana nokulethwa kwe-imeyili, ukuqedwa kwenkokhelo noma ukungena kwe-SSO okuqediwe.

Ukuvikeleka kuncike eqenjini ngalinye. Ama-endpoint omphakathi ezomthetho, ezokumaketha namafomu awadingi iseshini yedashibhodi. I-chat widget yona isebenzisa i-header `X-Widget-Token` ne-origin allowlist. Ukungena kudashibhodi kunikeza i-JWT yeseshini ehlala amahora ayishumi nambili ne-refresh token esebenza izinsuku eziyisikhombisa. Ama-endpoint e-SSO asebenza ngamakhodi awo okusetshenziswa kanye nezinqubo ze-callback.

Funda ikhasi le-endpoint ngalinye njengesivumelwano esizimele. Okubalulekile yi-HTTP method, i-path, amapharamitha ayimpoqo, izinhlobo zedatha, i-request body, isakhiwo se-response, amakhodi amaphutha ne-idempotency. Isibonelo sibonisa ifomethi engenzeka, kodwa asithathi indawo yokuhlola impendulo yangempela. Isimo sokulungiselelwa, ukuqinisekiswa kwedatha, izimvume nabahlinzeki bangaphandle kungashintsha umphumela.

Umkhawulo wezinga oqinisekisiwe wenkundla yonke uyizicelo ezingu-2 000 phakathi kwemizuzu engu-15. Imikhawulo ehlukile nge-endpoint ngayinye ayibhalwanga yonke indawo. Ngakho ama-client akufanele asebenzise ama-polling loop aqinile ngokungadingekile. Emisebenzini engeyona i-idempotent, ukuphinda okuzenzakalelayo kungadala amarekhodi noma imilayezo ephindiwe.

Amanani abucayi akufanele abe kumarekhodi (logs). Lokhu kufaka amaphasiwedi, ama-reset token, amakhodi okuqinisekisa, ama-widget token, ama-session ID nedatha yangempela yesibonelo yomuntu siqu. Sebenzisa amanani angaziwa emibhalweni nasekuhlolweni. Amanothi okuhlolwa bukhoma kufanele abonise ngokunembile ubufakazi bangempela.