REST API Overview

The platform exposes a comprehensive REST API under /api/, allowing you to build custom storefronts, mobile apps, third-party integrations, and automation scripts.

Authentication

The API uses Laravel Sanctum for token-based authentication.

Obtaining a Token

POST /api/auth/login
Content-Type: application/json

{
  "email": "[email protected]",
  "password": "your-password"
}

Response includes a token field. Pass it as a Bearer token on subsequent requests:

Authorization: Bearer {your-token}

Response Format

All responses use a consistent envelope:

{
  "status": true,
  "message": "Products retrieved successfully",
  "data": { ... }
}

Validation errors return HTTP 422 with an errors object.

Versioning

The API is versioned via the URL prefix. The current stable version is /api/v1/. Breaking changes are only introduced in a new version.

Rate Limiting

API requests are rate-limited to 60 requests per minute per authenticated user. Exceeding this returns HTTP 429 with a Retry-After header.

REST API Overview