PHP MySQL API Documentation

This is a RESTful API built with PHP and MySQL. It provides endpoints for user authentication and product management.

The API uses JWT (JSON Web Tokens) for authentication and follows RESTful conventions for endpoint design.

All responses are in JSON format and include a status field indicating success or error.

Authentication is handled via JWT tokens. To authenticate, you need to:

1. Register a new user or login with existing credentials
2. Use the token received in the response
3. Include the token in the Authorization header for protected routes

Example: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxIiwiaXNzIjoiUEhQIE15U1FMIEFQSSIsImlhdCI6MTcwMDU2NTA2MCwiZXhwIjoxNzAwNTY4NjYwfQ.3jZ6CU8K9DMb1MK

{
  "status": "success",
  "message": "Success",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "user": {
      "id": 1,
      "name": "John Doe",
      "email": "john@example.com"
    }
  }
}

{
  "status": "success",
  "message": "Success",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "user": {
      "id": 1,
      "name": "John Doe",
      "email": "john@example.com"
    }
  }
}

{
  "status": "success",
  "message": "Success",
  "data": {
    "user": {
      "id": 1,
      "name": "John Doe",
      "email": "john@example.com",
      "created_at": "2023-11-21 15:30:45"
    }
  }
}

The following endpoints allow you to manage products.

{
  "status": "success",
  "message": "Success",
  "data": {
    "products": [
      {
        "id": 1,
        "user_id": 1,
        "name": "Smartphone",
        "description": "Latest model with great camera",
        "price": "599.99",
        "created_at": "2023-11-21 16:30:00",
        "updated_at": null
      },
      {
        "id": 2,
        "user_id": 1,
        "name": "Laptop",
        "description": "Powerful laptop for developers",
        "price": "1299.99",
        "created_at": "2023-11-21 16:35:00",
        "updated_at": null
      }
    ],
    "pagination": {
      "total": 2,
      "page": 1,
      "limit": 10,
      "pages": 1
    }
  }
}

{
  "status": "success",
  "message": "Success",
  "data": {
    "product": {
      "id": 1,
      "user_id": 1,
      "name": "Smartphone",
      "description": "Latest model with great camera",
      "price": "599.99",
      "created_at": "2023-11-21 16:30:00",
      "updated_at": null
    }
  }
}

{
  "status": "success",
  "message": "Product created successfully",
  "data": {
    "product": {
      "id": 3,
      "user_id": 1,
      "name": "Headphones",
      "description": "Noise cancelling headphones",
      "price": "199.99",
      "created_at": "2023-11-21 17:00:00",
      "updated_at": null
    }
  }
}

{
  "status": "success",
  "message": "Success",
  "data": {
    "product": {
      "id": 1,
      "user_id": 1,
      "name": "Smartphone Pro",
      "description": "Latest model with great camera and improved battery",
      "price": "699.99",
      "created_at": "2023-11-21 16:30:00",
      "updated_at": "2023-11-21 17:30:00"
    }
  }
}

{
  "status": "success",
  "message": "Product deleted successfully",
  "data": []
}

When an error occurs, the API will return a JSON response with a status of "error" and additional information:

{
  "status": "error",
  "message": "Error message description",
  "errors": []  // Additional error details if available
}

Common HTTP Status Codes: