POST/api/auth/forgot-password
Huanzisha utumaji wa barua pepe ya kuweka upya nenosiri, ikiwa akaunti yenye anwani hii ipo. Kwa makusudi hujibu kwa njia ileile kila mara (haiwezekani kukisia kama akaunti ipo).
Ukurasa „POST /api/auth/forgot-password — Marejeleo ya API“ unashughulikia eneo la utendaji lililotajwa katika URL. Maudhui yaliyopo yanaongezewa mtiririko halisi, masharti ya awali na mipaka inayojulikana. Zentor haina mfumo wa funguo za API kwa wasanidi programu. Kwa dashibodi, JWT za kipindi zenye muda wa saa kumi na mbili na refresh tokens zenye muda wa siku saba hutumiwa; TOTP na SSO ni za hiari. Embed tokens za widget huonyeshwa mara moja tu kwa maandishi wazi na zimefungwa kwa origins zilizoidhinishwa. Nyaraka za `POST /api/auth/forgot-password` lazima zisomwe kama maelezo ya kiufundi ya endpoint hii mahususi. Mambo muhimu ni method, path, uthibitishaji, sehemu za lazima, hitilafu zinazowezekana na swali la iwapo kuita tena kunaleta athari ileile. Kwa hivyo sehemu hii ya msaada https://zentor-app.de/hilfe/api-referenz/auth/auth.forgot_password haipaswi kuwa na madai ya jumla ya kimatangazo, bali hatua za muunganisho zinazoweza kufuatiliwa na mifano ya majibu iliyothibitishwa pekee. Kwa kuita `/api/auth/forgot-password`, ombi hujengwa kulingana na Registry. Njia za umma hazihitaji ufunguo wa jumla wa API wa wasanidi, kwa sababu Zentor haitoi mfumo kama huo wa funguo. Kinyume chake, njia za widget zilizolindwa hutumia embed token inayoonyeshwa mara moja pamoja na ukaguzi wa origin. Hali ya HTTP na maudhui ya JSON lazima vitathminiwe pamoja; sehemu ya `ok` peke yake haichukui nafasi ya kushughulikia hitilafu. Wakati wa kujaribu `POST /api/auth/forgot-password`, thamani zisizotambulisha watu zinapaswa kutumika. Data halisi ya wateja, UUID za mfumo wa uzalishaji, tokeni za vipindi na mihuri halisi ya muda haziruhusiwi katika mifano ya umma. Kikomo kinachojulikana cha jukwaa zima ni maombi 2.000 ndani ya dakika 15; kikomo tofauti mahususi hakijathibitishwa. Maombi ya POST yasiyo idempotent hayapaswi kurudiwa bila kufikiri baada ya kukatika kwa mtandao kusikoeleweka. Hitilafu za kawaida za muunganisho kwa njia hii husababishwa na vigezo vya lazima vinavyokosekana, aina zisizo sahihi za data, misimbo ya matumizi moja iliyokwisha muda, origins zisizoruhusiwa au rekodi ya data ambayo haijatekelezwa. Programu inapaswa kushughulikia hali hizo kando na kurekodi ujumbe wa hitilafu unaorudishwa na endpoint bila kuandika maudhui ya siri. Ombi lililofanikiwa linathibitisha hatua hii ya uchakataji pekee, si moja kwa moja kufanikiwa kwa barua pepe, malipo au SSO kunakofuata baadaye. Hili linahusika moja kwa moja kwa „POST /api/auth/forgot-password“. Ukaguzi wa kiufundi wa ukurasa huu lazima utegemee Registry iliyo chini ya `app/frontend/src/content/api-reference/` na njia za backend zinazohusiana. Maelezo ya majaribio ya moja kwa moja yanaweza kudai tu kile kilichokaguliwa kweli. Jaribio hasi au mfanano wa msimbo si uthibitisho kamili wa mafanikio. Kwa hivyo kwa POST /api/auth/forgot-password — Marejeleo ya API lazima kutofautishwe waziwazi kati ya muundo ulioandikwa, jaribio la kiotomatiki na tabia ya moja kwa moja iliyoshuhudiwa kwa uhakika.
Uthibitishaji na ulinzi
Hakuna uthibitishaji unaohitajika
Idempotent: Ndiyo
Vigezo
email(body, string, inahitajika)— Barua pepe ya akauntiMfano wa ombi (request)
{"email":"user@example.com"}Mfano wa jibu (response)
{"ok":true}Misimbo ya hitilafu
400 VALIDATION_ERROR — Sehemu ya barua pepe haipo au iko tupu.Uthibitisho wa jaribio la moja kwa moja
Mafanikio (200, jibu lisiloegemea upande wowote bila kujali kama akaunti ipo) na kesi hasi (400 wakati sehemu haipo) yamethibitishwa moja kwa moja (live).