Ireferensi ye-API
Iindawo zokugqibela zoluntu ze-API zabaphuhlisi: iifomu, i-widget, i-configurator yemveliso nokunye.
Esi salathiso sichaza kuphela iindawo zokuphela ze-JSON zokwenyani ezisebenziseka esidlangalaleni -- i-method, i-path, uhlobo lokuqinisekisa, iiparamitha ezinyanzelekileyo, umzekelo we-request ne-response kunye neekhowudi zeempazamo ezibhaliweyo kwindawo yokuphela nganye. Inkqubo jikelele yezitshixo ze-API zabaphuhlisi ayikho kwiZentor; ukufikelela kwenzeka, ngokuxhomekeke kwindlela, nokuba ngaphandle kokuqinisekiswa okanye nge-widget embed token enokuhlolwa kwe-origin. Iindlela zangaphakathi zedashibhodi neendawo zokuphela ze-Master Admin ngabom aziyonxalenye yesi salathiso soluntu, kuba zifikeleleka kuphela ngeseshoni yokungena eqhelekileyo.
Ungeniso ngalunye lwendawo yokuphela lunenqaku lovavanyo oluphilayo elibonisa ukuba ingaba inkcazelo ivela kwi-schema ye-registry, kuvavanyo oluzenzekelayo okanye kuqwalaselo oluphilayo lokwenyani -- ukufana nje nendlela yekhowudi esebenzayo akuthathwa njengobungqina obupheleleyo. Ukongeza, ukubizwa okuphumeleleyo ngokobuchwepheshe kuhlala kuqinisekisa kuphela ukucutshungulwa kwe-request leyo, hayi ngokuzenzekelayo iinkqubo ezilandelayo ezifana nokuhanjiswa kwe-imeyile, ukugqitywa kwentlawulo okanye ukungena kwe-SSO okugqityiweyo.
Ukhuseleko luxhomekeke kwiqela ngalinye. Iindawo zokuphela zoluntu zomthetho, zentengiso nezeefomu azifuni seshoni yedashibhodi. I-widget yencoko, ngokwahlukileyo, isebenzisa i-header `X-Widget-Token` kunye ne-allowlist ye-origin. Ukungena kwidashibhodi kunika i-JWT yeseshoni esebenza iiyure ezilishumi elinesibini kunye ne-refresh token esebenza iintsuku ezisixhenxe. Iindawo zokuphela ze-SSO zisebenza ngeekhowudi zazo zesihlandlo esinye kunye neenkqubo ze-callback.
Funda iphepha ngalinye lendawo yokuphela njengesivumelwano esizimeleyo. Okubalulekileyo yi-HTTP method, i-path, iiparamitha ezinyanzelekileyo, iintlobo zedatha, i-request body, ulwakhiwo lwe-response, iikhowudi zeempazamo kunye ne-idempotency. Umzekelo ubonisa ifomathi enokwenzeka, kodwa awuthathi indawo yokuhlola impendulo yokwenyani. Isimo soqwalaselo, uqinisekiso, iimvume nababoneleli bangaphandle banokutshintsha isiphumo.
Umda wesantya oqinisekisiweyo weqonga lonke zii-request ezingama-2 000 kwimizuzu eli-15. Imida eyahlukileyo yendawo yokuphela nganye ayibhalwanga ngokupheleleyo. Ngoko ke abathengi (clients) akufuneki basebenzise imijikelo ye-polling engqingqwa ngokungeyomfuneko. Kwimisebenzi engeyo-idempotent, ukuphinda okuzenzekelayo kunokwenza iirekhodi okanye imiyalezo ephindiweyo.
Amaxabiso abuthathaka akafanelekanga kwiilogi. Oku kuquka iiphasiwedi, ii-reset token, iikhowudi zoqinisekiso, ii-widget token, ii-ID zeseshoni kunye nedatha yomzekelo yobuqu yokwenyani. Sebenzisa amaxabiso angaziwayo kumaxwebhu nakwiimvavanyo. Amanqaku ovavanyo oluphilayo kufuneka abonise ngokuchanekileyo ubungqina bokwenyani.