Register a new user in the system.
URL: /users/register
Method: POST
Request Body:
{
"fullname": {
"firstname": "string",
"lastname": "string"
},
"email": "string",
"password": "string"
}Validation Rules:
firstname: Minimum 3 charactersemail: Must be a valid email formatpassword: Minimum 6 characters
Success Response:
- Code: 201 Created
- Content:
{
"user": {
"fullname": {
"firstname": "string",
"lastname": "string"
},
"email": "string"
},
"token": "JWT_TOKEN"
}Example:
{
"user": {
"fullname": {
"firstname": "John",
"lastname": "Doe"
},
"email": "john.doe@example.com"
},
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}Error Response:
- Code: 400 Bad Request
- Content:
{
"errors": [
{
"param": "field_name",
"msg": "error message"
}
]
}Example:
{
"errors": [
{
"param": "email",
"msg": "Invalid email format"
},
{
"param": "password",
"msg": "Password must be at least 6 characters long"
}
]
}Login an existing user.
URL: /users/login
Method: POST
Request Body:
{
"email": "string",
"password": "string"
}Validation Rules:
email: Must be a valid email formatpassword: Minimum 6 characters
Success Response:
- Code: 200 OK
- Content:
{
"user": {
"fullname": {
"firstname": "string",
"lastname": "string"
},
"email": "string"
},
"token": "JWT_TOKEN"
}Example:
{
"user": {
"fullname": {
"firstname": "John",
"lastname": "Doe"
},
"email": "john.doe@example.com"
},
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}Error Response:
- Code: 401 Unauthorized
- Content:
{
"message": "Invalid email or password"
}Get the profile of the authenticated user.
URL: /users/profile
Method: GET
Authentication: Required (JWT Token in Authorization header or cookies)
Success Response:
- Code: 200 OK
- Content:
{
"fullname": {
"firstname": "string",
"lastname": "string"
},
"email": "string"
}Example:
{
"fullname": {
"firstname": "John",
"lastname": "Doe"
},
"email": "john.doe@example.com"
}Error Response:
- Code: 401 Unauthorized
- Content:
{
"message": "Unauthorized"
}Logout the currently authenticated user.
URL: /users/logout
Method: GET
Authentication: Required (JWT Token in Authorization header or cookies)
Success Response:
- Code: 200 OK
- Content:
{
"message": "Logged out successfully"
}Error Response:
- Code: 401 Unauthorized
- Content:
{
"message": "Unauthorized"
}Register a new captain in the system.
URL: /captains/register
Method: POST
Request Body:
{
"fullname": {
"firstname": "string", // min 3 characters
"lastname": "string" // optional
},
"email": "string", // must be valid email format
"password": "string", // min 6 characters
"vehicle": {
"color": "string", // min 3 characters
"plate": "string", // min 3 characters
"capacity": "number", // min 1
"vehicleType": "string" // must be: "car" | "motorcycle" | "auto"
}
}Success Response:
{
"captain": {
"fullname": {
"firstname": "string",
"lastname": "string"
},
"email": "string",
"vehicle": {
"color": "string",
"plate": "string",
"capacity": "number",
"vehicleType": "string"
}
},
"token": "JWT_TOKEN" // valid for 24 hours
}Example:
{
"captain": {
"fullname": {
"firstname": "Mike",
"lastname": "Smith"
},
"email": "mike.smith@example.com",
"vehicle": {
"color": "black",
"plate": "ABC123",
"capacity": 4,
"vehicleType": "car"
}
},
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}Error Response:
- Code: 400 Bad Request
- Content:
{
"errors": [
{
"param": "field_name",
"msg": "error message"
}
]
}Example:
{
"errors": [
{
"param": "vehicle.vehicleType",
"msg": "Invalid vehicle type"
},
{
"param": "vehicle.capacity",
"msg": "Capacity must be atleast 1"
}
]
}URL: /captains/login
Method: POST
Request Body:
{
"email": "string", // must be valid email
"password": "string" // min 6 characters
}Success Response:
{
"captain": {
"fullname": {
"firstname": "string",
"lastname": "string"
},
"email": "string",
"vehicle": {
"color": "string",
"plate": "string",
"capacity": "number",
"vehicleType": "string"
}
},
"token": "JWT_TOKEN" // stored in cookies and valid for 24 hours
}Error Response:
{
"message": "Invalid email or password"
}URL: /captains/profile
Method: GET
Authentication: Required (JWT Token in Authorization header or cookies)
Success Response:
{
"captain": {
"fullname": {
"firstname": "string",
"lastname": "string"
},
"email": "string",
"vehicle": {
"color": "string",
"plate": "string",
"capacity": "number",
"vehicleType": "string"
}
}
}Error Response:
{
"message": "Unauthorized" // when token is invalid or missing
}URL: /captains/logout
Method: GET
Authentication: Required (JWT Token in Authorization header or cookies)
Success Response:
{
"message": "Logout successfully"
}Error Response:
{
"message": "Unauthorized" // when token is invalid or missing
}Notes:
- All routes return 401 Unauthorized if the authentication token is invalid
- Tokens are blacklisted on logout and cannot be reused
- Vehicle type must be one of: "car", "motorcycle", "auto"
- All passwords are hashed before storage
- Email addresses must be unique in the system