Referansa API

Ev referans tenê endpointên JSON yên rastîn û bi awayekî giştî bikarhatî vedibêje -- ji bo her endpointekê rêbaz, rê (path), cureyê rastkirina nasnameyê, parametreyên mecbûrî, mînaka request û response û kodên çewtiyê yên belgekirî. Li Zentorê pergaleke giştî ya mifteyên API ji bo pêşdebiran tune ye; li gorî rêyê, gihîştin an bê rastkirina nasnameyê, an jî bi tokeneke bicihkirina wîdcetê ya bi kontrola originê pêk tê. Rêyên navxweyî yên dashboardê û endpointên Master Adminê bi zanebûn ne beşek ji vê referansa giştî ne, ji ber ku ew tenê bi rêya danişîna têketinê ya asayî têne gihîştin.

Her tomara endpointê nîşeyeke ceribandina zindî dihewîne ku eşkere dike ka agahî ji şemaya registryê, ji ceribandineke otomatîk an ji çavdêriyeke zindî ya rastîn tê -- tenê wekheviya bi rêyeke kodê ya ku dixebite re wekî delîleke temam nayê hesibandin. Herwiha, bangeke ku ji aliyê teknîkî ve serkeftî ye her tim tenê pêvajoya wê requestê bi xwe piştrast dike, ne bi awayekî otomatîk pêvajoyên paşê yên wekî gihandina e-nameyê, temamkirina dravdanê an têketineke SSO ya temamkirî.

Parastin bi koma têkildar ve girêdayî ye. Endpointên giştî yên hiqûqî, bazarkirinê û forman pêdiviya wan bi danişîneke dashboardê nîne. Lê belê wîdceta chatê sernivîsa `X-Widget-Token` û lîsteyeke originên destûrdayî bi kar tîne. Têketinên dashboardê JWT-yeke danişînê ya diwanzdeh saetan derbasdar û tokeneke nûkirinê ya heft rojan derbasdar didin. Endpointên SSO bi kodên xwe yên yekcarî û herikînên callbackê dixebitin.

Her rûpela endpointê wekî peymaneke serbixwe bixwînin. Ya diyarker rêbaza HTTP, rê, parametreyên mecbûrî, cureyên daneyan, laşê requestê, avahiya responseê, kodên çewtiyê û idempotansî ne. Mînakek formateke gengaz nîşan dide, lê cihê kontrolkirina bersiva rastîn nagire. Rewşa konfîgurasyonê, pejirandin (validation), destûr û dabînkerên derveyî dikarin encamê biguherînin.

Sînorê rêjeyê (rate limit) yê piştrastkirî li seranserê platformê di nava 15 deqeyan de 2.000 request e. Sînorên cuda ji bo her endpointê bi tevahî nehatine belgekirin. Ji ber vê yekê divê client lûpên polling ên bê hewce teng bi kar neynin. Di operasyonên ne-idempotent de, dubarekirinên otomatîk dikarin tomar an peyamên ducarî çêbikin.

Nirxên hesas nabe ku bikevin nav logan. Ev yek şîfre, tokenên nûvekirinê (reset), kodên piştrastkirinê, tokenên wîdcetê, nasnameyên danişînê (session ID) û daneyên mînakê yên bi daneyên kesane yên rastîn dihewîne. Di belgekirin û ceribandinan de nirxên anonîmkirî bi kar bînin. Nîşeyên ceribandina zindî divê delîla rastîn bi rastî nîşan bidin.