API Documentation for User Management System

http://<your-server-address>

1. Register User

POST auth/register

Registers a new user in the system.

Request Body (JSON):

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

Response:

• 201 Created: Registration successful, email verification required.
• 400 Bad Request: Missing or invalid input.
• 409 Conflict: Username or email already exists.

2. Confirm Email

GET auth/confirm/<token>

Verifies the user's email address using the provided token.

URL Parameters:

• token: Email verification token.

Response:

• 200 OK: Email verified successfully.
• 400 Bad Request: Invalid or expired token.
• 404 Not Found: User not found.

3. Forgot Password

POST auth/forgot-password

Sends a password reset link to the user's registered email address.

Request Body (JSON):

{
  "email": "string"
}

Response:

• 200 OK: Reset link sent to the email.
• 400 Bad Request: Invalid email format.
• 404 Not Found: Email not registered.

2. Get Dashboard Data

GET /dashboard

Fetches dashboard data for the authenticated user, including project information.

Authorization:

This endpoint requires a valid JWT token for authentication.

Response:

• 200 OK: Returns dashboard data successfully.
• 404 Not Found: No projects found for the user.
• 500 Internal Server Error: An unexpected error occurred.

Response Body (JSON):

{
  "dashboard": [
    {
      "project_name": "string",
      "num_keywords": "integer",
      "num_competitors": "integer"
    }
  ]
}

1. Get or Update Project

GET /api/projects/<project_id>

Retrieves the details of a project for the authenticated user.

PUT /api/projects/<project_id>

Updates the details of a project for the authenticated user.

URL Parameters:

• project_id: The ID of the project to retrieve or update.

Request Body (PUT only):

• name: (Optional) New name for the project.
• myket_url: (Optional) Updated Myket URL.
• bazar_url: (Optional) Updated Bazar URL.
• googleplay_url: (Optional) Updated Google Play URL.
• keywords: (Optional) List of updated keywords.
• competitors_urls: (Optional) List of updated competitor URLs.

Response:

GET:

• 200 OK: Returns project details in JSON format.
• 404 Not Found: Project not found or access denied.

PUT:

• 200 OK: Project updated successfully.
• 400 Bad Request: Invalid input (e.g., invalid keywords format).
• 404 Not Found: Project not found or access denied.

3. Create Project

POST /api/projects

Creates a new project for the authenticated user.

Authorization:

This endpoint requires a valid JWT token for authentication.

Request Body (JSON):

{
  "name": "string",
  "myket_url": "string",
  "bazar_url": "string",
  "googleplay_url": "string",
  "keywords": ["string", "string"],
  "competitors_urls": ["string", "string"]
}

Response:

• 201 Created: Project created successfully.
• 400 Bad Request: Invalid or missing input.
• 500 Internal Server Error: An unexpected error occurred.

Response Body (JSON):

{
  "message": "Project created successfully",
  "project_id": "integer"
}

4. Reset Password

POST auth/reset-password/<token>

Allows the user to reset their password using a reset token.

URL Parameters:

• token: Password reset token.

Request Body (JSON):

{
  "password": "string"
}

Response:

• 200 OK: Password reset successfully.
• 400 Bad Request: Invalid or expired token, or missing password.

5. Login

POST auth/login

Authenticates a user and generates access and refresh tokens.

Request Body (JSON):

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

Response:

• 200 OK: Login successful, returns tokens.
• 400 Bad Request: Missing input.
• 401 Unauthorized: Invalid credentials.
• 403 Forbidden: Email not verified.

Response Example:

{
  "access_token": "string",
  "refresh_token": "string"
}

6. Refresh Token

POST /refresh

Generates a new access token using the provided refresh token.

Headers:

• Authorization: Bearer <refresh_token>

Response:

• 200 OK: Returns a new access token.
• 401 Unauthorized: Invalid or expired refresh token.

Response Example:

{
  "access_token": "string"
}

7. Health Check

GET /health

Confirms the API is operational.

Response:

• 200 OK: API is running properly.

1.bazaar Daily Stars

POST /bazaar_daily_stars

Retrieves the daily star rating changes for a specific app over a given number of days.

Request Body (JSON):

{
  "url": "string",  // Required: The unique URL of the app
  "days": "integer" // Optional: Number of days to calculate changes (default: 30)
}

Response:

• 200 OK: An array of objects containing the daily star changes.

  [
    {
      "app_name": "string",
      "url": "string",
      "date": "string",
      "onestar_change": "integer",
      "twostar_change": "integer",
      "threestar_change": "integer",
      "fourstar_change": "integer",
      "fivestar_change": "integer"
    }
  ]

• 400 Bad Request: URL is required but not provided.
• 404 Not Found: No data found for the given URL.