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

# Welcome to Scale

> Build your own online storefront using Scale Headless APIs

Welcome to the **Scale Developer Documentation** — a comprehensive suite of headless APIs that lets you build your own custom e-commerce experiences on top of Scale.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get up and running with the Scale API in under 5 minutes.
  </Card>

  <Card title="API Keys" icon="key" href="/api-keys">
    Learn how to authenticate public and private requests.
  </Card>

  <Card title="Storefront APIs" icon="code" href="/storefront/shop">
    Expose your products catalog, handle categories, and submit checkouts.
  </Card>

  <Card title="Management APIs" icon="terminal" href="/management/products">
    Programmatically create products, sync inventory, and update order statuses.
  </Card>
</CardGroup>

***

## Headless API Architecture

Scale provides two logical layers of API endpoints to power custom integrations:

### 1. Storefront API (Public)

Designed to run directly in the browser or mobile applications. These endpoints require a **Public / Publishable API Key** (`pk_...`) which is safe to expose in client-side code.

* Fetch store profiles & operating hours
* Search and list catalog products/variants
* Fetch categories & collections
* Place orders (checkout submissions)

### 2. Shop Management API (Private)

Designed to run on backend servers or sync scripts. These endpoints require a **Secret API Key** (`sk_...`) which must be kept secret.

* Full inventory sync (Create, Edit, Delete products and variants)
* Order management (Fetch list, Update fulfillment/payment statuses)
* Customer databases & storefront settings management

***

## Developer Support

If you need help or want to report issues with the API:

* View the [GitHub Repository](https://github.com/IndigoSoftwares21/scale_api_docs)
* Email us at [support@getscale.ng](mailto:support@getscale.ng)
