Intégrations et API REST : comment ça marche
Intégrations et API permet à d'autres logiciels de travailler avec vos données. Une clé API autorise un autre système à lire les clients, prospects, devis, factures, commandes et produits, et à en créer certains ; les webhooks préviennent un autre système dès qu'un événement se produit ici. Utilisez-les pour relier des outils comptables, des services d'automatisation ou votre propre application.
Leçon 2 sur 9 · Comment ça marche
Comment ça marche
«System → Integrations → Integrations & API» affiche quatre chiffres en haut : «Active keys», «Endpoints», «Delivered (7 d)» et «Failed». En dessous se trouvent les panneaux «API keys», «Webhook endpoints» et «Event catalog».
Appuyez sur «Create key», donnez-lui un nom qui indique où elle est utilisée, cochez ses portées (scopes) et, si vous le souhaitez, une date d'expiration. Une portée est le droit de lire ou d'écrire un type d'enregistrement. L'écriture inclut la lecture.
La nouvelle clé n'est affichée qu'une seule fois sous «Your new API key». Copiez-la tout de suite : seule une empreinte est conservée, elle ne pourra donc plus être affichée.
L'autre système envoie la clé avec chaque requête. Il peut lister et lire les clients, prospects, devis, factures, commandes et produits, et créer des clients, des prospects, des devis brouillons et des factures brouillons.
Un prospect créé par l'API déclenche les mêmes Messages La messagerie du personnel dans l'administration : messages directs, discussions de groupe et canaux comme #general. Tapez @ suivi d'un nom pour mentionner un collègue. Plus de mots dans le glossaire que le formulaire du site. Les devis et factures créés par l'API sont toujours des brouillons, avec une taxe calculée comme dans l'éditeur de l'administration. L'API ne les envoie jamais et ne les marque jamais comme payés.
Chaque ligne de clé affiche ses portées, son créateur, le nombre de requêtes et la dernière utilisation, avec le badge «Active», «Expired» ou «Revoked». «Revoke» bloque une clé immédiatement.
«API docs» ouvre la référence complète pour un développeur, et «Delivery log» ouvre la liste des envois de webhooks.
Où le trouver
- System → Integrations → Integrations & API
/admin/integrations - Integrations & API → API docs
/admin/integrations/docs - Integrations & API → Delivery log
/admin/integrations/deliveries
Réglages qui le modifient
- Apps & modules (Automation & integrations)
/admin/apps
Liste de contrôle
Avant de continuer, vérifiez que vous savez :
- Ouvrir System → Integrations → Integrations & API
- System → Integrations → Integrations & API affiche quatre chiffres en haut : Active keys, Endpoints,…
- Appuyez sur Create key, donnez-lui un nom qui indique où elle est utilisée, cochez ses portées (scopes) et,…
- La nouvelle clé n'est affichée qu'une seule fois sous Your new API key.
- L'autre système envoie la clé avec chaque requête.
Astuces et erreurs fréquentes
- Clé perdue ? Elle ne peut pas être récupérée. Révoquez l'ancienne et créez-en une nouvelle.
- Une requête refusée pour une portée manquante signifie que la clé a été créée sans ce droit. Créez une nouvelle clé en cochant cette portée.
- Une clé peut envoyer 300 requêtes d'un coup, puis 5 par seconde. Un système qui demande plus vite est prié d'attendre, et des refus répétés depuis une même adresse peuvent entraîner un blocage temporaire.
- Traitez une clé comme un mot de passe. Donnez à chaque système connecté sa propre clé, pour pouvoir en révoquer une sans arrêter les autres.