Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/JuanSCaicedo/Api-Ecommerce/llms.txt

Use this file to discover all available pages before exploring further.

API Ecommerce is a production-ready RESTful API built with Laravel 10, powering a complete e-commerce platform. It handles authentication (with role-based access for admins and customers), a multi-level product catalog with variations and specifications, a shopping cart with coupon support, checkout via MercadoPago, order management, product reviews, and a full admin panel for content management.

Quickstart

Make your first authenticated API call in minutes

Authentication

Learn JWT authentication, token refresh, and role separation

Storefront API

Explore home feed, products, cart, and checkout endpoints

Admin API

Manage products, categories, discounts, and site configuration

​
How the API is organized

The API has two major surface areas, each with its own authentication context:

Storefront

Customer-facing endpoints — browsing products, managing a cart, placing orders, writing reviews, and managing profile and shipping addresses.

Admin Panel

Admin-only endpoints — full CRUD for products, categories, brands, variations, sliders, discount campaigns, and coupons.

Core Concepts

Understand the request/response format, rate limiting, caching strategy, and error codes used across every endpoint.

Deployment

Configure environment variables, connect OCI object storage, and set up the GitHub Actions CI/CD pipeline.

​
Get up and running

1

Clone and install

Clone the repository and install PHP dependencies with Composer.
git clone https://github.com/JuanSCaicedo/Api-Ecommerce.git
cd Api-Ecommerce
composer install
2

Configure your environment

Copy .env.example to .env, generate an application key, and configure your database and JWT secret.
cp .env.example .env
php artisan key:generate
php artisan jwt:secret
3

Run migrations

Create the database schema and seed initial data.
php artisan migrate --seed
4

Start the server

Launch the development server and start calling the API at http://localhost:8000/api.
php artisan serve
All API endpoints are prefixed with /api. The storefront endpoints live under /api/ecommerce/ and the admin endpoints under /api/admin/. Authentication endpoints are at /api/auth/.

Build docs developers (and LLMs) love

Get started for freeTalk to us