Démarrage rapide - 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.

1

Créez un jeton

Depuis les paramètres de votre espace Bonx, section Tokens d’API (voir Authentification).

2

Configurez votre environnement

export BONX_API_URL="https://VOTRE-URL-API"
export BONX_API_KEY="bxk_live_..."

$env:BONX_API_URL = "https://VOTRE-URL-API"
$env:BONX_API_KEY = "bxk_live_..."

3

Appelez un endpoint

curl "$BONX_API_URL/sales-orders?limit=2" \
  -H "x-api-key: $BONX_API_KEY"

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()

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[] }

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

Référence

Tous les endpoints, avec leurs champs et leurs exemples.

Exemples

Des cas concrets, prêts à adapter.