Password Recovery
This guide explains how to implement password recovery in the Sumaya369 application.
Forgot Password
Endpoint
- Method: POST
- URL:
/v1/customer/forgot-password
Request Headers
| Header | Value | Required |
|---|---|---|
| Content-Type | application/json | Yes |
| Accept | application/json | Yes |
Request Body
| Parameter | Type | Description | Required |
|---|---|---|---|
| string | Registered email address | Yes |
Success Response
{
"status": true,
"message": "تم إرسال تعليمات إعادة تعيين كلمة المرور",
"data": null
}
Error Responses
Email Not Found (422)
{
"status": false,
"message": "البريد الإلكتروني غير موجود",
"data": null
}
Reset Password
Endpoint
- Method: POST
- URL:
/v1/customer/reset-password/token
Request Headers
| Header | Value | Required |
|---|---|---|
| Content-Type | application/json | Yes |
| Accept | application/json | Yes |
Request Body
| Parameter | Type | Description | Required |
|---|---|---|---|
| password | string | New password (min 6 characters) | Yes |
| password_confirmation | string | Confirm new password | Yes |
Success Response
{
"status": true,
"message": "تم إعادة تعيين كلمة المرور بنجاح",
"data": null
}
Error Responses
Invalid Token (422)
{
"status": false,
"message": "رمز إعادة التعيين غير صالح",
"data": null
}
Example Implementation Flow
- Password Recovery Process
- User requests password reset via
/v1/customer/forgot-password - User receives password reset instructions
- User sets new password via
/v1/customer/reset-password/{token
- User requests password reset via
Key Considerations
- Provide clear instructions to users during password reset
- Validate password strength and confirmation
- Handle password reset errors gracefully