Démarrage rapide

Cette page vous guide pour créer une clé API, appeler l'API avec cURL, puis faire la même chose depuis Node.js.

1. Créer une clé API

1. Connectez-vous à votre dashboard boxioo
2. Ouvrez Clés API
3. Cliquez sur Créer une clé
4. Renseignez :
   • Nom — un libellé pour identifier la clé (Zapier production, Job BI nocturne…)
   • Scopes — commencez par objects:read et records:read ; vous pourrez toujours créer une autre clé avec plus de privilèges plus tard
5. Cliquez sur Créer. La clé complète n'est affichée qu'une seule fois — copiez-la immédiatement dans votre gestionnaire de secrets.

2. Votre premier appel

Listez les objets définis dans votre tenant :

curl https://api.boxioo.com/v1/objects \
  -H "Authorization: ApiKey bk_live_xxxxxxxxxxxxxxxx"

Réponse attendue (tronquée) :

{
  "data": [
    {
      "id": "0c4a…",
      "apiName": "contact",
      "name": "Contact",
      "description": "Nos contacts",
      "icon": "user",
      "createdAt": "2026-04-12T08:31:00Z"
    }
  ],
  "pagination": { "limit": 25, "offset": 0, "total": 1, "hasMore": false }
}

3. Le même appel, depuis Node.js

const res = await fetch('https://api.boxioo.com/v1/objects', {
  headers: {
    Authorization: `ApiKey ${process.env.DSIBOX_API_KEY}`,
  },
});
 
if (!res.ok) {
  const err = await res.json();
  throw new Error(`${err.error.code}: ${err.error.message}`);
}
 
const { data } = await res.json();
console.log(`${data.length} type(s) d'objet trouvé(s)`);

Le header Authorization est le seul paramètre obligatoire — votre tenant est dérivé de la clé.

4. Créer un enregistrement

Supposons que votre tenant ait un objet contact avec un champ first_name et un champ email. Voici comment créer un enregistrement :

curl -X POST https://api.boxioo.com/v1/objects/contact \
  -H "Authorization: ApiKey bk_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "fields": {
      "first_name": "Alice",
      "email": "alice@acme.com"
    }
  }'

Quelques points :

• Utilisez l'apiName de l'objet dans l'URL, pas son nom d'affichage
• Le corps est { "fields": { ... } }, indexé par le systemName de chaque champ
• Idempotency-Key est optionnel mais fortement recommandé — voir Idempotence

Étapes suivantes