Profile API

This documentation provides comprehensive details for the Profile API endpoints. The API supports retrieving user profile information, updating profile details, and uploading profile images for authenticated users.

Base URL: http://localhost:8080

Authentication

All Profile endpoints require Bearer token authentication. Include the access token in the Authorization header:

Authorization: Bearer <your_access_token>

Profile Endpoints

Method	Endpoint	Description	Authentication Required
GET	/profile	Retrieve user profile information	Yes
PUT	/profile	Update user profile information	Yes
POST	/profile/image-upload	Upload user profile image	Yes

---

Endpoint Details

1. Get User Profile

GET /profile

Retrieve the profile information for the authenticated user.

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes

Example Request

curl -X 'GET' \
  'http://localhost:8080/profile' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...'

Example Response

{
    "userId": "707ac264-be2e-4e89-b6d3-7a49b14263d2",
    "firstName": "Mehedi ",
    "lastName": "Hassan",
    "mobile": "01812353930",
    "faxNumber": "454",
    "streetAddress": "Dhaka",
    "city": "Dhaka",
    "postCode": "1205",
    "gender": "Male"
  }
}

Response Fields

Field	Type	Description
userId	string	Unique identifier for the user
firstName	string	User's first name
lastName	string	User's last name
mobile	string	User's mobile phone number
faxNumber	string	User's fax number
streetAddress	string	User's street address
city	string	User's city
postCode	string	User's postal code
gender	string	User's gender

---

2. Update User Profile

PUT /profile

Update profile information for the authenticated user.

Query Parameters

Parameter	Type	Required	Description
firstName	string	No	User's first name
lastName	string	No	User's last name
mobile	string	No	User's mobile phone number
faxNumber	string	No	User's fax number
streetAddress	string	No	User's street address
city	string	No	User's city
postCode	string	No	User's postal code
gender	string	No	User's gender

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes

Example Request

curl -X 'PUT' \
  'http://localhost:8080/profile?firstName=Mehedi&lastName=Hassan&mobile=01812353930&faxNumber=454&streetAddress=Dhaka&city=Dhaka&postCode=1205&gender=Male' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...'

Example Response

{
    "userId": "707ac264-be2e-4e89-b6d3-7a49b14263d2",
    "firstName": "Mehedi",
    "lastName": "Hassan",
    "mobile": "01812353930",
    "faxNumber": "454",
    "streetAddress": "Dhaka",
    "city": "Dhaka",
    "postCode": "1205",
    "gender": "Male"
  }
}

---

3. Upload Profile Image

POST /profile/image-upload

Upload a profile image for the authenticated user. The image will be processed and stored with a unique filename.

Request Body

Parameter	Type	Required	Description
image	file	Yes	Image file (multipart/form-data)

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes
Content-Type	multipart/form-data	Yes

Supported Image Formats

• JPEG (.jpg, .jpeg)
• PNG (.png)
• GIF (.gif)

Example Request

curl -X 'POST' \
  'http://localhost:8080/profile/image-upload' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...' \
  -H 'Content-Type: multipart/form-data' \
  -F 'image=@profile.jpg;type=image/jpeg'

Example Response

"73b21d27-466e-45c6-bc2b-0480eb4db2d2.jpg"

Response Fields

Field	Type	Description
data	string	Unique filename of the uploaded image

---

Error Handling

This API follows industry-standard error handling patterns (Stripe, GitHub, OpenAI):

Success Responses

• HTTP status code indicates success (200, 201, 204)
• Response body contains data directly (no wrapper object)
• No isSuccess or statusCode fields needed

Error Responses

Standard Error (400/401/403/404/500):

{
  "message": "Error description"
}

Validation Error (400):

{
  "message": "Validation failed",
  "errors": [
    {"field": "email", "message": "Invalid email format"},
    {"field": "password", "message": "Password must be at least 8 characters"}
  ]
}

Common Error Codes

Status Code	Description	Example Message
400	Bad Request	"Invalid email or password"
401	Unauthorized	"Authentication required"
403	Forbidden	"Insufficient permissions"
404	Not Found	"Product not found"
409	Conflict	"User already exists with this email"
500	Internal Server Error	"Internal server error"

All error messages are centralized and consistent across all endpoints.

---