Laravel API Endpoints is a comprehensive starter-kit designed for authentication and account recovery, built on the Laravel Sanctum framework. This package is fully compatible with the sveltekit-dashboard-starter for a seamless user experience.
Laravel API Endpoints is a complete authentication and account recovery starter-kit developed on the top of the Laravel Sanctum. This package is completely compatible with sveltekit-dashboard-starter.
This package encompasses a range of features, including but not limited to:
- User registration.
- Email verification.
- Secure login options via either email or mobile number.
- Logout.
- Mobile number verification utilizing OTP.
- Activity logs based on user and associated actions.
- Support for localization.
- User-friendly response and error messaging.
It includes the following endpoints:
| Details | Method | API End Points |
|---|---|---|
| Registration | POST | /register |
| Email verification link | POST | /email-verification |
| Email verification | POST | /verify-email/{id}/{hash} |
| Mobile verification OTP | POST | /verification-otp |
| Mobile verification | POST | /verify-mobile |
| Login | POST | /login |
| Password reset request | POST | /password-reset |
| Change Password | POST | /reset-password |
| Logout | GET | /logout |
Request Method: POST
Endpoint: /register
Request Body
{
"name": "M B Parvez",
"mobile": "01717000000",
"email": "user1@email.com",
"password": "password1",
"password_confirmation": "password1",
"country" : "bd",
"country_code" : "88"
}Request Header
{
"Content-Type": "application/json"
"Accept": "application/json"
}Response
{
"user": {
"name": "M B Parvez",
"email": "user1@email.com",
"mobile": "01717000000",
"country": "bd",
"country_code": "88",
"updated_at": "2022-05-08T13:09:53.000000Z",
"created_at": "2022-05-08T13:09:53.000000Z",
"id": 1
},
"token": "1|qaPeBQyYYYIFDZZ8JPS7OOFONWy1LlgHSg5EzsW8",
"success": true,
"message": "Account created successfully!"
}Upon completing your registration, an email verification link will be automatically generated and sent to your registered email address. However, in the event that you require manual or second-time verification, you may utilize this end-point.
Request Method: POST
Endpoint: /email-verification
Request Body
{
"email": "user1@email.com"
}Request Header
{
"Content-Type": "application/json"
"Accept": "application/json",
'Authorization': "Bearer <SANCTUM_AUTH_TOKEN>"
}Response
{
"success": true,
"message": "An email verification link has been sent to your inbox. Please check your email and follow the instructions to complete the verification process."
}By utilizing this end-point, the user account associated with the provided email address can be verified via the URL sent for verification purposes.
Request Method: POST
Endpoint: /verify-email/{id}/{hash}
Request Header
{
"Content-Type": "application/json"
"Accept": "application/json",
'Authorization': "Bearer <SANCTUM_AUTH_TOKEN>"
}Response
{
"success": true,
"message": "Your email has been successfully confirmed!"
}Request Method: POST
Endpoint: /login
User can use either Email or mobile number asuserIDfor login
Request Body
{
"userID": "user1@email.com", // or 01717000000
"password": "password1"
}Request Header
{
"Content-Type": "application/json"
"Accept": "application/json"
}Response
{
"user": {
"id": 1,
"name": "M B Parvez",
"email": "user1@email.com",
"email_verified_at": null,
"created_at": "2022-05-07T13:26:20.000000Z",
"updated_at": "2022-05-07T13:26:20.000000Z"
},
"token": "2|MyddQxXZvBJ6spzKOI3Kubjte6q3QqS0IYZpZ0uw",
"success": true,
"error": false
}Request Method: POST
Endpoint: /password-reset
Request Body
{
"userID": "user1@email.com", // or 01717000000
}You may choose to use either your email or mobile number as your
userIDduring login. In both cases, a four to eight digit OTP will be sent to you via either email or mobile, depending on the chosenuserID.
Request Header
{
"Content-Type": "application/json"
"Accept": "application/json"
}Response
{
"success": true,
"message": "Please check your Email and use to code to reset password."
}Request Method: POST
Endpoint: /reset-password
Request Body
{
"otp": "123456",
"password" : "password2", // New password
"password_confirmation" : "password2", // New password confirmation
"token": "3b1c32e4-8729-481a-8de2-27e3287f8ac3"
}Will be added automatically with the password reset request.
Request Header
{
"Content-Type": "application/json"
"Accept": "application/json"
}Response
{
"success": true,
"message": "Password updated successfully! Login to your account to continue."
}Request Method: GET
Endpoint: /logout
Request Header
{
"Content-Type": "application/json"
"Accept": "application/json",
'Authorization': "Bearer <SANCTUM_AUTH_TOKEN>"
}Replace SANCTUM_AUTH_TOKEN with real token
To tailor the Laravel API Endpoints to suit your particular use case, please modify the following ENV variables accordingly:
| Details | Value | API End Points |
|---|---|---|
| SITE_URL | "https://www.mbparvez.me" | URL of the website where the API will be utilized. |
| EMAIL_VERIFICATION_URL | "${SITE_URL}/verify?verify_url=" | Email verification URL of the website. |
| MOBILE_NUMBER_REQUIRED | true/false Default: true |
Specify whether a mobile number is required for registration or not. |
| OTP_NUMBER_LENGTH | 4 to 8 Default: 6 |
Length of the OTP |
| OTP_EXPIRE_TIME | 300 | Duration of the OTP expiration in seconds |
| ** VERIFY_USER_BY | "email" | -- |
| MONTHLY_PASSWORD_RESET_LIMIT | 15 | Maximum monthly limit for password reset. |
| WEEKLY_PASSWORD_RESET_LIMIT | 6 | Maximum weekly limit for password reset. |
| DAILY_PASSWORD_RESET_LIMIT | 3 | Maximum daily limit for password reset. |
| INFOBIP_BASE_URL | Null | Infobip API URL |
| INFOBIP_TIMEOUT | Null | Infobip request timeout |
| INFOBIP_API_KEY | Null | Infobip API key |
Code and documentation copyright 2022 the M B Parvez and Gosoft. Code released under the MIT License.