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

# Einführung

> Willkommen bei der Scango API Dokumentation

Um die API nutzen zu können, muss zuerst ein API-Key generiert werden. Dieser kann unter Einstellungen > Organisation > API Key erstellt werden.

### Basis-URL

`https://dashboard.scango.ch/api/v1`

### Authentifizierung

* Typ: Bearer Token
* Verwendung: Fügen Sie das Bearer Token in den Authorization-Header für alle Anfragen ein.

### OpenAPI-Spezifikation

Die maschinenlesbare API-Definition liegt unter [`api-reference/openapi.json`](/api-reference/openapi.json). Nutzen Sie sie mit OpenAPI-fähigen Tools, Codegeneratoren oder Assistenten.

### Listen-Antworten (`meta`)

Jeder **Listen**-Endpunkt liefert `data` (das Array) und zusätzlich **`meta`** mit mindestens:

| Feld       | Bedeutung                                                                                                                                                                                         |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `total`    | Bei **Produktsuche** mit `q` die **geschätzte** Trefferzahl des Suchindexes. Bei allen anderen Listen entspricht der Wert der Anzahl der in dieser Antwort gelieferten Einträge (wie `returned`). |
| `returned` | Anzahl der Einträge im Array `data` in dieser Antwort.                                                                                                                                            |
| `limit`    | Angewendete Seitengröße aus dem Abfrageparameter `limit` (Standard **100**, Maximum **5000**). Bei Produktsuche mit `q` liegt die effektive Obergrenze bei **250**.                               |

Listen-Endpunkte unterstützen einen optionalen Abfrageparameter **`limit`** (Standard 100, Maximum 5000). Bei **Produktsuche** mit `q` enthält `meta` außerdem **`offset`** für die Paginierung.

## API-Struktur

Die Scango API bietet Zugriff auf folgende Hauptressourcen:

<CardGroup>
  <Card title="Agent-Rezepte" icon="sparkles" href="/api-reference/de/agent-recipes">
    Schritt-für-Schritt-Abläufe für Automation und KI-Assistenten
  </Card>

  <Card title="Produkte" icon="box" href="/api-reference/endpoint/products">
    Verwalten Sie Ihren Produktkatalog
  </Card>

  <Card title="Bestellungen" icon="shopping-cart" href="/api-reference/endpoint/orders">
    Greifen Sie auf Bestellinformationen zu
  </Card>

  <Card title="Lieferanten" icon="truck" href="/api-reference/endpoint/suppliers">
    Sehen Sie Lieferantendetails ein
  </Card>

  <Card title="Kategorien" icon="folder-tree" href="/api-reference/endpoint/categories">
    Durchsuchen Sie Produktkategorien
  </Card>
</CardGroup>

## Wichtige Hinweise

<Note>
  Aktuell können Produktbilder nicht über die API hochgeladen werden.
</Note>

<Note>
  Webhooks sind noch nicht verfügbar. Wir empfehlen, in gewünschten Intervallen nach neuen Bestellungen zu prüfen.
</Note>