Créer et gérer les clés API

À quoi ça sert

Une clé API donne à un outil tiers un accès précis à votre organisation : quels périmètres, quels rôles, quelles entités du CRM, quelles opérations de facturation. Vous créez une clé pour chaque outil ou chaque usage, consultez à tout moment ce qu'elle est autorisée à faire et son activité récente, et la révoquez si elle n'est plus utile ou si le secret a fui.

Concepts clés

• Clé API — un secret unique par outil tiers, affiché en clair une seule fois, à la création.
• Accès CRM — par entité, les opérations autorisées : « Lecture », « Création », « Modification ». La lecture est le plancher : une clé ne peut pas créer ou modifier une entité qu'elle ne peut pas lire.
• Accès Facturation — la lecture des devis et des factures, avec leurs PDF, accordée séparément pour chacun. Les entités légales sont lisibles dès que l'un des deux l'est.
• États d'une clé — « Active », « Expire bientôt », « Expirée », « Révoquée ». Voir le tableau de référence.
• Expiration — une date au-delà de laquelle la clé cesse de fonctionner, ou « Jamais ». Elle se choisit à la création et peut être changée ensuite.
• Périmètres — les périmètres dont la clé voit les données : une clé ne lit et n'écrit que les fiches, devis et factures de ses périmètres. Au moins un est obligatoire.
• Rôles — les rôles que la clé détient, facultatifs. Une entité ou un champ du CRM réservé à certains rôles n'atteint la clé que si elle en détient un ; de même pour la création et la modification d'une entité réservées à des rôles.
• Accès figés — les périmètres, les rôles et les accès d'une clé ne changent plus après sa création. Pour lui donner d'autres accès, créez une nouvelle clé et révoquez l'ancienne.

Comment faire

Créer une clé API

1. Sur la page « API publique », cliquez sur « Nouvelle ».
2. Renseignez le « Nom » de la clé, par exemple « Zapier — synchro contacts ».
3. Choisissez son « Expiration » : « Dans 90 jours », « Dans 1 an (recommandé) », « Dans 2 ans » ou « Jamais ».
4. Choisissez un ou plusieurs « Périmètres ». Si l'organisation n'en a qu'un seul, il est sélectionné d'office et la liste est grisée.
5. Si la clé doit atteindre des entités ou des champs réservés à des rôles, choisissez ses « Rôles ». Le champ est grisé pour qui n'est pas administrateur de l'organisation : « Les rôles d'une clé sont réservés à l'administrateur de l'organisation. »
6. Dans « Accès », cochez pour chaque entité CRM les opérations voulues, et pour « Devis » et « Factures » la lecture si besoin.
7. Cliquez sur « Créer la clé ».

Le secret s'affiche une seule fois, sous « Clé créée ». Copiez-le immédiatement : si vous le perdez, révoquez la clé et créez-en une nouvelle. Sans nom, sans périmètre ou sans aucun accès coché, la création est refusée avec un message : « Donnez un nom à la clé. », « Choisissez au moins un périmètre. » ou « Accordez au moins un accès. ».

Tant que le secret est affiché, la touche Échap et un clic à côté de la fenêtre ne la ferment pas : seul « Terminer » la ferme, pour ne pas perdre le secret. Pendant la création, « Annuler » est inactif.

Consulter les accès d'une clé

1. Sur la page « API publique », cliquez sur une clé dans la liste.
2. Ouvrez l'onglet « Accès ».

La page liste les périmètres et les rôles de la clé (« Aucun rôle. » s'il n'y en a pas), ses entités CRM avec les opérations accordées, et son accès aux devis et aux factures. Une entité supprimée depuis la création de la clé apparaît comme « Entité supprimée ». Une opération accordée à la clé mais coupée depuis pour toute l'organisation apparaît barrée, avec la mention « Coupé pour toute l'organisation ».

Tester une clé

1. Ouvrez l'onglet « Accès » de la clé : le bloc « Tester la clé » donne une commande prête à l'emploi, à compléter avec le secret copié à la création.

Ce test suppose de connaître le secret complet, qui n'est jamais réaffiché après sa création.

Renommer une clé

1. Ouvrez la clé, puis cliquez sur l'icône en forme de crayon à côté de son nom.
2. Saisissez le nouveau nom et cliquez sur « Enregistrer ».

Le message « Clé renommée » confirme.

Changer la date d'expiration d'une clé

1. Ouvrez la clé, puis cliquez sur la date affichée sous « Expire ».
2. Choisissez une nouvelle durée et cliquez sur « Enregistrer ».

Le message « Expiration modifiée » confirme. Une clé révoquée ne propose plus cette action.

Consulter le journal des appels d'une clé

1. Ouvrez la clé, puis l'onglet « Activité ».
2. Cliquez sur « Voir plus » pour charger les appels plus anciens.

Chaque ligne indique le moment de l'appel, sa méthode, son chemin et son statut. Le nombre d'appels des dernières 24 heures est affiché sur la fiche de la clé, sous « Appels 24 h » ; si ce nombre n'a pas pu être lu, « Indisponible » s'affiche à la place.

Si le journal ne se charge pas, « Impossible de charger l'activité de la clé. » s'affiche avec un bouton « Réessayer » ; de même « Impossible de charger la suite de l'activité. » quand « Voir plus » échoue.

Révoquer une clé

1. Ouvrez la clé, puis l'onglet « Révocation ».
2. Tapez le nom exact de la clé dans le champ de confirmation.
3. Cliquez sur « Révoquer définitivement ».

La révocation coupe l'outil immédiatement et ne peut pas être annulée. Le message « Clé révoquée » confirme, et l'onglet affiche ensuite la date de révocation.

Référence

États d'une clé

Durées d'expiration proposées

Ce qui reste modifiable après la création

Pour changer les accès d'un outil, créez une nouvelle clé avec les accès voulus, puis révoquez l'ancienne.

Auteur des actions faites avec une clé

Quand une clé API crée ou modifie une fiche, elle apparaît comme auteur de l'action à la place d'un utilisateur : « Clé API » suivi de son nom dans le CRM, ou « Clé API » suivi de son préfixe dans l'historique des autres modules. Cela reste vrai après la révocation de la clé.

Messages liés aux périmètres et aux rôles

Messages liés aux périmètres et aux rôles

Questions fréquentes

Puis-je récupérer une clé perdue ?

Non. Le secret n'est affiché qu'une seule fois, à la création. Révoquez la clé et créez-en une nouvelle.

Puis-je élargir les accès d'une clé existante ?

Non. Les accès d'une clé sont figés à la création. Créez une nouvelle clé avec les accès voulus, puis révoquez celle qui ne convient plus.

Une clé révoquée ou expirée peut-elle être réactivée ?

Non dans les deux cas. Créez une nouvelle clé si l'accès est encore nécessaire.