Skip to main content

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

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes

Request Body

ParameterTypeDescriptionRequired
emailstringRegistered email addressYes

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

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes

Request Body

ParameterTypeDescriptionRequired
passwordstringNew password (min 6 characters)Yes
password_confirmationstringConfirm new passwordYes

Success Response

{
"status": true,
"message": "تم إعادة تعيين كلمة المرور بنجاح",
"data": null
}

Error Responses

Invalid Token (422)

{
"status": false,
"message": "رمز إعادة التعيين غير صالح",
"data": null
}

Example Implementation Flow

  1. 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

Key Considerations

  • Provide clear instructions to users during password reset
  • Validate password strength and confirmation
  • Handle password reset errors gracefully