Avant de commencer
- Cette page s'adresse surtout à la personne qui s'occupe de l'informatique (ou à votre prestataire) : une API est un moyen, pour un logiciel, d'interroger un autre logiciel automatiquement.
- Seuls les propriétaires et administrateurs peuvent créer une clé.
- Toute clé est en lecture seule : elle ne permet jamais de modifier ou de créer quoi que ce soit. Elle ne donne accès qu'aux données de votre organisation.
Générer une clé
- Ouvrez Paramètres › Connexions et données › Intégrations, carte API.
- Dans Générer une clé, saisissez un nom (obligatoire, par exemple « Logiciel comptable »). Prévoyez une clé par logiciel : chacune est révocable séparément.
- Choisissez la durée de validité (Expire dans 90 jours, Expire dans 1 an ou Sans expiration) et cliquez sur Générer.
- La clé s'affiche dans un cadre « Clé créée — copiez-la maintenant, elle ne sera plus affichée ». Cliquez sur Copier (le bouton affiche « Copié ✓ »).
Votre logiciel doit envoyer cette clé dans l'en-tête Authorization: Bearer <clé> de chaque requête, à l'adresse affichée sous la clé (qui se termine par /api/v1).
Ce que l'API permet de lire
| Données | Adresses |
|---|---|
| Commandes | /commandes (liste, filtrable par statut) et /commandes/:id |
| Factures | /factures (filtrable par commande) et /factures/:id |
| Expéditions | /expeditions (filtrable par commande) et /expeditions/:id |
| Produits | /produits et /produits/:id |
La page propose la documentation complète de l'API (exemples de requêtes et de réponses), à télécharger en Markdown (à donner à un assistant IA) ou en PDF (pour une personne). Les listes sont paginées (50 lignes par défaut, 200 au maximum) et la limite est de 120 requêtes par minute pour l'ensemble des clés de l'organisation.
Suivre et révoquer
Le tableau liste vos clés (nom, fin de la clé, dernier usage, expiration). Révoquer coupe l'accès immédiatement (la ligne indique « Révoquée »). Une clé révoquée, expirée ou erronée reçoit l'erreur 401.
Traitez la clé comme un mot de passe : ne la collez pas dans un message ou un document partagé. Si elle a fuité, révoquez-la et créez-en une autre.
Et ensuite ?
Pour un usage sans programmation, préférez l'export des données ou les exports de listes (commandes, factures).