POST/api/auth/forgot-password
கடவுச்சொல் மீட்டமைப்பைத் தொடங்குகிறது: கொடுக்கப்பட்ட மின்னஞ்சல் முகவரியுடன் கணக்கு இருந்தால், அது மீட்டமைப்பு இணைப்புடன் ஒரு மின்னஞ்சலைப் பெறும்.
கணக்கின் மின்னஞ்சல் முகவரியை `email` புலத்தில் அனுப்பவும். பதில் `{"ok":true}` வேண்டுமென்றே எப்போதும் ஒரே மாதிரியாக இருக்கும் - கணக்கு இருந்தாலும் இல்லாவிட்டாலும் - இந்த எண்ட்பாயிண்ட் மூலம் எந்த முகவரிகள் பதிவு செய்யப்பட்டுள்ளன என்பதைக் கண்டறிய முடியாதபடி. புதிய கடவுச்சொல் பின்னர் மின்னஞ்சலிலுள்ள டோக்கனுடன் `POST /api/auth/reset-password` மூலம் அமைக்கப்படுகிறது. `email` புலம் இல்லாவிட்டால் அல்லது வெறுமையாக இருந்தால், எண்ட்பாயிண்ட் 400 `VALIDATION_ERROR` உடன் பதிலளிக்கிறது. தவறான பயன்பாட்டைத் தடுக்க, ஒரு IP முகவரிக்கான கோரிக்கைகளின் எண்ணிக்கை வரையறுக்கப்பட்டுள்ளது (429 `RATE_LIMIT_EXCEEDED`).
கண்ணோட்டம்
அழைப்பு: POST /api/auth/forgot-password. இந்த எண்ட்பாயிண்ட் Zentor App API-யின் “அங்கீகாரம்” குழுவைச் சேர்ந்தது. இது பொதுவில் அணுகக்கூடியது; அங்கீகாரம் (authentication) தேவையில்லை. இந்த அழைப்பு idempotent ஆகும்: அதே உள்ளீடுகளுடன் மீண்டும் மீண்டும் அழைத்தால் அதே முடிவு கிடைக்கும். கட்டாய அளவுருக்கள்: email (பாடி). ஆவணப்படுத்தப்பட்ட பிழை நிலைகள்: 400 VALIDATION_ERROR. கீழே உள்ள மாதிரி பதில், JSON வடிவில் வெற்றிகரமான பதிலின் கட்டமைப்பைக் காட்டுகிறது.
அங்கீகாரம் & பாதுகாப்பு
அங்கீகாரம் தேவையில்லை
Idempotent (மீண்டும் செய்தாலும் அதே விளைவு): ஆம்
அளவுருக்கள்
email(body, string, கட்டாயம்)— கணக்கின் மின்னஞ்சல் முகவரிஎடுத்துக்காட்டுக் கோரிக்கை
{"email":"user@example.com"}எடுத்துக்காட்டுப் பதில்
{"ok":true}பிழைக் குறியீடுகள்
400 VALIDATION_ERROR — `email` புலம் இல்லை அல்லது வெறுமையானது.சரிபார்க்கப்பட்ட நடத்தை
கணக்கு இருந்தாலும் இல்லாவிட்டாலும் பதில் 200 `{"ok":true}`; விடுபட்ட மின்னஞ்சல் புலம் 400 `VALIDATION_ERROR` ஐத் திருப்பும்.
அங்கீகாரம்
POST /api/auth/loginமின்னஞ்சல் முகவரி அல்லது பயனர்பெயர் மற்றும் கடவுச்சொல் மூலம் பயனரை உள்நுழைவு செய்து, ஒரு அணுகல் டோக்கன் (JWT) மற்றும் ஒரு புதுப்பிப்பு டோக்கனை வெளியிடுகிறது.POST /api/auth/refreshசெல்லுபடியான புதுப்பிப்பு டோக்கனை புதிய அணுகல் டோக்கன் மற்றும் புதுப்பிப்பு டோக்கனின் ஜோடியுடன் மாற்றுகிறது.POST /api/auth/reset-passwordகடவுச்சொல் மீட்டமைப்பு மின்னஞ்சலிலுள்ள மீட்டமைப்பு டோக்கனைப் பயன்படுத்தி புதிய கடவுச்சொல்லை அமைக்கிறது.POST /api/auth/sso/exchangeSSO உள்நுழைவின் (SAML/OIDC) இறுதிப் படி: திருப்பிவிடுதலிலிருந்து ஒருமுறை பயன்படும் குறியீட்டை அணுகல் டோக்கன் மற்றும் புதுப்பிப்பு டோக்கனுடன் மாற்றுகிறது.