Créer une clé API
Connecter un logiciel tiers ou un script à tes projets, en lecture seule
Une clé API permet à un autre logiciel — ton ERP, ta GED, un script maison — de lire tes projets ArchiCollab sans que tu aies à lui confier ton mot de passe.
Qui peut faire ça ? Toute personne membre d'une agence. Les clients et invités n'ont pas accès à cette fonction.
Créer ta clé
- Va dans Réglages → Intégrations
- Dans le bloc Clés API, clique sur Créer une clé
- Donne-lui un nom qui décrit son usage — « connecteur ERP », « export mensuel ». Ce nom te servira à savoir laquelle révoquer le jour où tu en auras plusieurs
- Choisis une durée de vie. 90 jours convient à la plupart des usages ; « Jamais » est pratique mais t'oblige à surveiller la clé toi-même
- Clique sur Créer
La clé n'est affichée qu'une seule fois. Copie-la immédiatement et range-la dans le gestionnaire de secrets de ton logiciel. Nous n'en conservons qu'une empreinte : même le support ne peut pas te la redonner. Si tu la perds, révoque-la et crées-en une autre — c'est sans conséquence.
Ce que la clé peut faire
Exactement ce que tu peux faire, ni plus ni moins. Elle voit les projets auxquels tu as accès, avec les mêmes droits. Si tu n'es pas sur un projet, ta clé ne le voit pas.
Et elle est en lecture seule : une clé ne peut rien créer, rien modifier, rien supprimer. C'est volontaire — un logiciel tiers ou un assistant IA ne doit pas pouvoir toucher à tes documents.
Ce qui se passe si tu quittes l'agence
Ta clé cesse de fonctionner immédiatement, à la seconde où ton appartenance est retirée. Personne n'a besoin de penser à la révoquer : ton accès est revérifié à chaque appel.
C'est aussi vrai si ton rôle change : la clé suit tes droits du moment, pas ceux que tu avais le jour où tu l'as créée.
Révoquer une clé
Dans le même bloc, clique sur l'icône de corbeille. La clé cesse de fonctionner immédiatement, et tout logiciel qui l'utilisait perd l'accès. Fais-le sans hésiter dès qu'une clé n'est plus utilisée, ou si tu as un doute sur l'endroit où elle a été copiée.
Vérifier ce à quoi une clé donne droit
Ton développeur peut interroger cette adresse pour savoir précisément ce que la clé voit :
GET https://www.collab.archi/api/v1/me
x-api-key: ta_cléLa réponse liste l'organisation rattachée, le rôle, et le nombre de projets accessibles.
Bonnes pratiques
- Une clé par usage. Tu peux en avoir jusqu'à dix. Une clé par logiciel te permet de révoquer l'un sans couper les autres
- Jamais dans un dépôt de code. Une clé copiée dans Git y reste, même après suppression du fichier
- Mets une expiration. Une clé qui expire toute seule est une clé que tu ne peux pas oublier
Voir aussi
- Configurer un webhook — pour être notifié d'un changement, plutôt que d'aller le lire
- Rôles et permissions — ce que chaque rôle peut voir