Passer au contenu
Français
  • Il n'y a aucune suggestion car le champ de recherche est vide.

Comment créer et gérer des clés API pour connecter d'autres logiciels à Corfix ?

Cet article vous explique ce que sont les clés API, comment en créer une dans Corfix et comment en assurer la sécurité.

Si votre entreprise souhaite connecter Corfix à un autre système logiciel, tel qu’un logiciel de paie, de comptabilité ou une plateforme ERP, vous aurez besoin d’une clé API. Cet article vous guide dans la création, la modification et la suppression des clés API, et explique quels membres de votre équipe sont habilités à les gérer.

Conditions préalables / Avertissement
  • Vous devez disposer d’une autorisation pour gérer les clés API. Les autorisations relatives aux clés API doivent être activées pour votre rôle (voir « Qui peut gérer les clés API ? » ci-dessous). Si le bouton « Gérer les clés API » n’apparaît pas, veuillez contacter l’administrateur de votre entreprise.
  • Contactez votre responsable de la réussite client ou consultez la documentation sur les API.
  • Le secret de la clé n’est affiché qu’une seule fois. Lorsque vous créez une clé, Corfix affiche le secret une seule fois. Si vous le perdez, vous ne pourrez pas le récupérer : vous devrez supprimer la clé et en créer une nouvelle.
  • La suppression d’une clé est définitive. Toute connexion utilisant cette clé cessera immédiatement de fonctionner.
Présentation et explications

Une clé API fonctionne comme un mot de passe spécial destiné aux logiciels plutôt qu’aux personnes. Elle permet à un autre système, tel que votre plateforme de paie ou de comptabilité, de communiquer en toute sécurité avec Corfix au nom de votre entreprise sans que quiconque ait besoin de se connecter manuellement.

Chaque clé se compose de deux parties :

  • Un nom et une description afin que vous puissiez vous souvenir de l’utilisation de la clé (par exemple, « Acumatica »).
  • Un secret, qui correspond au mot de passe proprement dit utilisé par l’autre logiciel. Traitez-le comme n’importe quel autre mot de passe : gardez-le confidentiel et conservez-le dans un endroit sûr.

Chaque clé se voit également attribuer un rôle, qui détermine ce que le logiciel connecté est autorisé à voir et à faire dans Corfix. Par exemple, une clé à laquelle le rôle « Admin » a été attribué peut accéder aux mêmes informations qu’un utilisateur « Admin ».

Fonctionnement

Création d’une clé API

  1. Accédez à « Détails de mon compte » dans le menu de gauche.
  2. Sous « Détails de l’entreprise », cliquez sur « Gérer les clés API ».
  3. Sur la page « Clés API », cliquez sur le bouton bleu « Ajouter » en haut à droite.
  4. Dans la fenêtre « Ajouter une clé API » :
    • Saisissez un nom pour la clé (obligatoire, au moins 3 caractères). Choisissez un nom qui décrit ce à quoi elle se connecte, par exemple « Acumatica ».
    • Vous pouvez également ajouter une « Description » plus détaillée.
    • Sélectionnez un « Rôle ». Celui-ci détermine les éléments auxquels le logiciel connecté peut accéder. Choisissez le rôle le plus restrictif qui permette néanmoins à la connexion de fonctionner.
  5. Cliquez sur « Enregistrer ».
  6. Une fenêtre de confirmation s'affiche avec le secret de votre clé. Cliquez sur « Copier » et enregistrez immédiatement ce secret dans un emplacement sécurisé — c'est la seule fois où il s'affichera.
  7. Cliquez sur OK pour terminer. Votre nouvelle clé apparaît désormais dans la liste des clés API.

Modification ou suppression d’une clé API

  1. Sur la page « Clés API », repérez la clé dans la liste.
  2. Cliquez sur « Choisir une action » dans la colonne « Actions ».
  3. Sélectionnez « Modifier » pour mettre à jour le nom, la description ou le rôle de la clé, ou sélectionnez « Supprimer » pour la supprimer.

Avertissement : la suppression d’une clé déconnecte immédiatement tout logiciel qui l’utilise. Ne supprimez une clé que si vous êtes certain qu’elle n’est plus nécessaire ou si vous pensez que le secret a été compromis.

Qui peut gérer les clés API ?

Les administrateurs peuvent contrôler quels rôles sont autorisés à utiliser les clés API. Dans les paramètres de votre rôle, la section « Autorisations des clés API » contient quatre boutons :

  1. Afficher les clés API — consulter la liste des clés.
  2. Ajouter une clé API — créez de nouvelles clés.
  3. Modifier une clé API — modifiez le nom, la description ou le rôle d’une clé.
  4. Supprimer une clé API — supprimer des clés.

N'activez que les autorisations dont chaque rôle a besoin, puis cliquez sur « Enregistrer ».

Cas d’utilisation et avantages
  • Connectez votre logiciel de paie : transférez automatiquement les données de temps de travail et de paie entre Corfix et votre plateforme de paie, ce qui vous évite les exportations manuelles.
  • Synchronisez avec votre système comptable ou ERP : assurez la cohérence des projets et des enregistrements entre les différents systèmes, tels qu’Acumatica ou Sage.
  • Contrôlez précisément les données auxquelles les logiciels connectés ont accès : l’attribution d’un rôle à chaque clé garantit qu’une connexion ne voit que ce dont elle a besoin, rien de plus.
  • Révoquez l’accès instantanément : si une connexion n’est plus nécessaire ou si une clé secrète est compromise, la suppression de la clé coupe immédiatement l’accès.
  • Suivez vos connexions : la liste des clés API affiche le nom, la description, la date de création et le rôle de chaque clé, afin que vous sachiez toujours ce qui est connecté et pourquoi.