Marejeo ya API

Marejeleo haya yanaeleza pekee endpoints halisi za JSON zinazoweza kutumika hadharani -- method, path, aina ya uthibitishaji, vigezo vya lazima, mfano wa request na response pamoja na misimbo ya hitilafu iliyoandikwa kwa kila endpoint. Zentor haina mfumo wa jumla wa funguo za API kwa wasanidi; kulingana na njia, ufikiaji hufanyika ama bila uthibitishaji au kupitia embed token ya widget yenye ukaguzi wa origin. Njia za ndani za dashibodi na endpoints za Master Admin kwa makusudi si sehemu ya marejeleo haya ya umma, kwa kuwa zinafikiwa tu kupitia kipindi cha kawaida cha kuingia.

Kila ingizo la endpoint lina alama ya jaribio la moja kwa moja inayoonyesha ikiwa taarifa inatoka kwenye schema ya Registry, jaribio la kiotomatiki au uchunguzi halisi wa moja kwa moja -- kufanana tu na njia ya msimbo inayofanya kazi hakuhesabiwi kama uthibitisho kamili. Zaidi ya hayo, ombi lililofanikiwa kiufundi daima linathibitisha tu uchakataji wa request husika yenyewe, si moja kwa moja michakato inayofuata kama uwasilishaji wa barua pepe, kukamilika kwa malipo au kuingia kwa SSO kulikokamilika.

Ulinzi hutegemea kundi husika. Endpoints za umma za kisheria, za masoko na za fomu hazihitaji kipindi cha dashibodi. Kinyume chake, widget ya gumzo hutumia header `X-Widget-Token` na orodha ya origins zilizoidhinishwa. Kuingia kwenye dashibodi hutoa JWT ya kipindi yenye muda wa saa kumi na mbili na refresh token halali kwa siku saba. Endpoints za SSO hufanya kazi kwa misimbo yao ya matumizi moja na mitiririko ya callback.

Soma kila ukurasa wa endpoint kama mkataba unaojitegemea. Muhimu ni HTTP method, path, vigezo vya lazima, aina za data, request body, muundo wa response, misimbo ya hitilafu na idempotency. Mfano unaonyesha muundo unaowezekana, lakini hauchukui nafasi ya kukagua jibu halisi. Hali ya usanidi, uthibitishaji wa data, ruhusa na watoa huduma wa nje vinaweza kubadilisha matokeo.

Kikomo cha kasi kilichothibitishwa cha jukwaa zima ni requests 2.000 ndani ya dakika 15. Vikomo tofauti kwa kila endpoint havijaandikwa kila mahali. Kwa hivyo clients hazipaswi kutumia mizunguko ya polling iliyobanwa bila sababu. Kwa operesheni zisizo idempotent, marudio ya kiotomatiki yanaweza kuunda rekodi au jumbe maradufu.

Thamani nyeti haziruhusiwi katika kumbukumbu. Hizi ni pamoja na manenosiri, tokeni za kuweka upya, misimbo ya uthibitishaji, tokeni za widget, vitambulisho vya vipindi na data halisi za mifano ya kibinafsi. Tumia thamani zisizotambulisha watu katika nyaraka na majaribio. Maelezo ya majaribio ya moja kwa moja lazima yaakisi kwa usahihi uthibitisho halisi.