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

# Démarrage rapide

> Votre premier appel à l’API REST de Bonx.

Un endpoint par objet métier, une réponse JSON. C'est l'API à privilégier pour la
plupart des cas d'usage, et la voie pour écrire dans Bonx.

<Steps>
  <Step title="Créez un jeton">
    Depuis les paramètres de votre espace Bonx, section **Tokens d'API** (voir
    [Authentification](/fr/authentication)).
  </Step>

  <Step title="Configurez votre environnement">
    <CodeGroup>
      ```bash macOS / Linux theme={null}
      export BONX_API_URL="https://VOTRE-URL-API"
      export BONX_API_KEY="bxk_live_..."
      ```

      ```powershell Windows (PowerShell) theme={null}
      $env:BONX_API_URL = "https://VOTRE-URL-API"
      $env:BONX_API_KEY = "bxk_live_..."
      ```
    </CodeGroup>
  </Step>

  <Step title="Appelez un endpoint">
    <CodeGroup>
      ```bash cURL theme={null}
      curl "$BONX_API_URL/sales-orders?limit=2" \
        -H "x-api-key: $BONX_API_KEY"
      ```

      ```js JavaScript theme={null}
      const res = await fetch(`${process.env.BONX_API_URL}/sales-orders?limit=2`, {
        headers: { 'x-api-key': process.env.BONX_API_KEY },
      })
      const { salesOrders } = await res.json()
      ```

      ```ts TypeScript theme={null}
      type SalesOrder = { reference: string; stockAvailability: string }
      const res = await fetch(`${process.env.BONX_API_URL}/sales-orders?limit=2`, {
        headers: { 'x-api-key': process.env.BONX_API_KEY! },
      })
      const { salesOrders } = (await res.json()) as { salesOrders: SalesOrder[] }
      ```
    </CodeGroup>
  </Step>
</Steps>

## Les conventions

* **Authentification** : le jeton dans l'en-tête `x-api-key`, sur chaque appel.
* **Listes** : `limit` et `offset` en paramètres de requête, du plus récent au plus
  ancien sauf mention contraire.
* **Un enregistrement** : son identifiant dans le chemin, par exemple
  `/sales-orders/6`.
* **Écriture** : `POST` pour créer, `PUT` pour mettre à jour, corps JSON.

## Et ensuite

<CardGroup cols={2}>
  <Card title="Référence" icon="brackets-curly" href="/fr/api-reference/list-sales-orders">
    Tous les endpoints, avec leurs champs et leurs exemples.
  </Card>

  <Card title="Exemples" icon="code" href="/fr/examples/fetch-machine-jobs">
    Des cas concrets, prêts à adapter.
  </Card>
</CardGroup>