Accounts Application

This document describes the API endpoints for managing user accounts.

Base URL: /

Authentication:

Most API calls require authorization with a valid access token. You can obtain an access token by logging in with a username and password.

Login

• Method: POST
• Endpoints: /accounts/login/
• Request Body (JSON):

{
  "username": "string",
  "password": "string"
}

• Response:

{
  "access_token": "string"
}

• Description: Login to the application and get an access token for subsequent requests.

Register

• Method: POST
• Endpoints: /accounts/register/
• Request Body (JSON):

{
  "full_name": "string",
  "email": "string",
  "username": "string",
  "password": "string"
}

• Response:

{
  "message": "string",  // Success message
  "access_token": "string"
}

• Description: Register a new user account.

Get Current User Info

• Method: GET
• Endpoints: /accounts/me/
• Authorization: Bearer <access_token>
• Response:

{
  "success": true,
  "user": {
    "full_name": "string",
    "username": "string",
    "email": "string",
    "bio": "null|string",
    "profile_image": "null|string",
    "following_count": integer,
    "follower_count": integer,
    "is_follow": boolean,
    "is_verify": boolean
  }
}

• Description: Get information about the currently logged-in user.

Get Followers

• Method: GET
• Endpoints: /accounts/follower/
• Authorization: Bearer <access_token>
• Response:

{
  "success": true,
  "followerUsers": [
    # List of follower users account info.
  ]
}

• Description: Get a list of users who follow the currently logged-in user.

Get Following

• Method: GET
• Endpoints: /accounts/following/
• Authorization: Bearer <access_token>
• Response:

{
  "success": true,
  "followingUsers": [
    {
      # List of following users account info.
    }
  ]
}

• Description: Get a list of users who the currently logged-in user follows.

Get User Info by Username

• Method: GET
• Endpoints: /accounts/<username>/
• Path Variable:
  • <username>: The username of the user to retrieve information about.
• Response:

{
  "success": true,
  "user": {
    "full_name": "string",
    "username": "string",
    "bio": "null|string",
    "profile_image": "null|string",
    "following_count": integer,
    "follower_count": integer,
    "is_follow": boolean,
    "is_verify": boolean
  }
}

• Description: Get information about a specific user by their username.

Follow User

• Method: POST
• Endpoints: /accounts/follow/<username>/
• Authorization: Bearer <access_token>
• Path Variable:
  • <username>: The username of the user to follow.
• Response:

{
  "message": "You have followed/unfollow <username>." (depending on action) 
}

• Description: Follow a user.

Change Password

• Method: POST
• Endpoints: /accounts/password/change/
• Authorization: Bearer <access_token>
• Request Body (JSON):

{
  "old_password": "string",
  "new_password": "string"
}

• Response:

{
  "message": "string"  // Success message
}

• Description: Change the password for the currently logged-in user.

Update Profile

• Method: PUT
• Endpoints: /accounts/profile/update/
• Authorization: Bearer <access_token>
• Request Body (multipart/form-data):

{
  "full_name": "string",
  "email": "string",
  "username": "string",
  "profile_image": file (optional)
}

• Description: Update the profile information for the currently logged-in user.