> ## Documentation Index
> Fetch the complete documentation index at: https://secdocs.asikoexpress.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Everything you need to integrate with the Asiko platform API

The Asiko API powers both the retail storefront (asikoexpress.com) and the wholesale/trade
storefront (asikofoods.com) on a single backend: accounts, catalogue, cart and checkout,
orders, payments, loyalty and referrals, and notifications.

<Note>
  This reference documents the API as seen by an integrator — every request goes to a single
  host, **api-gateway**. You never call a backend service directly, even though the platform
  is built from several of them behind the scenes.
</Note>

## Base URL

| Environment       | Base URL                           |
| ----------------- | ---------------------------------- |
| Production        | `https://asikodevapi.candourit.io` |
| Local development | `http://localhost:3000`            |

Every route in this reference is prefixed with `/v1`.

## How this documentation is organized

<CardGroup cols={2}>
  <Card title="Guides" icon="book-open">
    Authentication, the response envelope, error shapes, rate limits, and how real-time
    notifications work. Read these first — they explain conventions shared by every endpoint.
  </Card>

  <Card title="API Reference" icon="code">
    Every endpoint reachable through the gateway, generated directly from the same OpenAPI
    schema the backend serves — grouped by resource (Auth & Account, Catalogue, Orders & Cart,
    Payments, Notifications & Loyalty, Admin, and admin-only Inventory).
  </Card>
</CardGroup>

## Interactive testing

Each reference page includes a **Try It** panel wired to the base URLs above, so you can send a
real request straight from the docs once you have an access token (see
[Authentication](/authentication)).

The platform's Swagger UI (linked at the top of this site) is generated straight from the same
`@nestjs/swagger` decorators in the source code and remains available as a lower-level console —
useful to backend engineers working on a single service, since it reflects that service's routes
exactly as implemented. This site is the recommended starting point for anyone integrating
against the public API.

## Platform composition

The gateway proxies every request to one of six backend services based on path prefix. This is
transparent to you as an API consumer — it's mentioned here only because service names appear in
a few places in this documentation (error logs, the `Notifications, Loyalty & Campaigns` grouping,
etc.):

| Resource area                                                                     | Backend service    |
| --------------------------------------------------------------------------------- | ------------------ |
| Auth, users, addresses, wholesale accounts                                        | user-service       |
| Products, categories, brands, reviews, recommendations, media, search             | product-service    |
| Cart, orders, wishlist, invoices                                                  | order-service      |
| Payments, payment provider webhooks                                               | payment-service    |
| In-app/email notifications, loyalty, referrals, campaigns, analytics, subscribers | engagement-service |
| Admin user & wholesale-application management                                     | admin-service      |