Une Factorial clé API IT authentifie les appels que vous faites à l'Factorial API IT, une API REST. Créez-en une lorsque vous souhaitez qu'une intégration ou un script lise ou modifie vos données via l'API.
Fonctionnalité
Vue d'ensemble
Les clés authentifient les demandes à l'Factorial API IT (REST). Il existe deux types, chacun avec sa propre portée :
- Clé API d'entreprise. Limitée à une seule entreprise. Elle ouvre chaque point de terminaison qui fonctionne sur des ressources au niveau de l'entreprise : appareils, employés, accessoires, tickets, SaaS et plus.
- Clé API d'espace de travail. Couvre l'ensemble de votre espace de travail. Elle ouvre les points de terminaison au niveau de l'espace de travail, par exemple pour lister et visualiser les entreprises dans votre espace de travail.
La plupart des points de terminaison nécessitent une Clé API d'entreprise. Seuls les points de terminaison de l'espace de travail (sous /workspace/) nécessitent une Clé API d'espace de travail. La référence API affiche un badge sur chaque point de terminaison avec le type attendu.
Comment utiliser : créer une clé API d'entreprise
- Allez dans Paramètres > Développeurs.
- Cliquez sur Créer une clé.
- Tapez un Nom de clé d'au moins 4 caractères, par exemple "Mon intégration".
- Définissez le Niveau d'accès sur Lecture seule ou Lecture/écriture.
- Si vous le souhaitez, définissez une Expiration (jours). Laissez-le vide pour une clé qui n'expire jamais.
- Cliquez sur Créer une clé, puis Copier le secret. Le secret n'est affiché qu'une seule fois.
Gardez la clé dans un endroit sûr. Quiconque la détient peut accéder à vos données via l'API.
Utiliser la clé
Envoyez la clé dans l'en-tête Authorization de chaque demande :
curl https://api.getFactorial IT.com/v1/devices \
-H "Authorization: Bearer YOUR_API_KEY"
Révoquer une clé
- Allez dans Paramètres > Développeurs et trouvez la clé sous Factorial IT API keys.
- Ouvrez le menu ⋯ sur sa ligne et cliquez sur Révoquer.
- Confirmez.
La clé cesse de fonctionner immédiatement et ne peut pas être récupérée. Les clés révoquées restent dans la liste afin que vous puissiez les retracer. Pour en supprimer une définitivement, ouvrez son menu ⋯ et cliquez sur Supprimer.
Voir les journaux API
Après que votre entreprise a envoyé sa première demande, une carte Voir les journaux API s'affiche dans l'onglet Développeurs. Cliquez dessus pour ouvrir les journaux API. La page liste les 50 dernières demandes REST et MCP pour votre entreprise. La colonne Acteur montre la clé, le client MCP ou l'employé derrière chacune d'elles.
Conseils et Meilleures Pratiques
- Choisissez Lecture seule sauf si l'intégration doit écrire. Donnez à chaque clé le niveau d'accès le plus bas qui fonctionne.
- Définissez une expiration pour les intégrations temporaires. Une clé qui n'expire jamais reste un risque jusqu'à ce que quelqu'un la révoque.
- Copiez le secret immédiatement. Il ne sera pas affiché à nouveau.
- Utilisez une clé par intégration. Un nom clair vous indique ce qui cesse de fonctionner lorsque vous la révoquez.
- Vérifiez les journaux API. La colonne Acteur montre qui appelle l'API.
Dépannage et FAQ
Dépannage
-
Un point de terminaison d'espace de travail rejette votre clé. Les points de terminaison sous
/workspace/nécessitent une Clé API d'espace de travail, pas une clé API d'entreprise. - Un point de terminaison d'entreprise rejette votre clé. La plupart des points de terminaison nécessitent une Clé API d'entreprise. Vérifiez le badge sur le point de terminaison dans la référence API.
- Une demande d'écriture échoue. La clé peut être Lecture seule. Créez une clé avec un accès Lecture/écriture.
- Une intégration a cessé de fonctionner. La clé peut avoir été révoquée ou avoir atteint son expiration. Créez une nouvelle clé.
- Vous ne voyez pas la carte Voir les journaux API. Elle n'apparaît qu'une fois que votre entreprise a effectué au moins une demande.
FAQ
-
Puis-je voir le secret à nouveau après avoir créé la clé ?
Non. Il n'est affiché qu'une seule fois. Si vous le perdez, créez une nouvelle clé.
-
Puis-je restaurer une clé révoquée ?
Non. Elle cesse de fonctionner immédiatement et ne peut pas être restaurée.
-
Pourquoi les clés révoquées sont-elles toujours listées ?
Pour la traçabilité. Utilisez Supprimer dans le menu ⋯ pour en retirer une définitivement.
-
Combien de demandes les journaux API montrent-ils ?
Les 50 demandes REST et MCP les plus récentes pour votre entreprise.