Gérer les clés API

Gestion et utilisation des clés API Mindee.

Aperçu

Les clés API sont des identifiants sécurisés qui permettent à vos applications d’interagir avec les services de Mindee.

Chaque clé est associée à votre organisation : l’utilisation et la facturation sont suivies en conséquence.

N’exposez jamais vos clés API dans un emplacement accessible publiquement !

Toute personne disposant de la clé pourra effectuer des requêtes API en se faisant passer pour votre organisation.

Une organisation peut avoir plusieurs clés API.

Chaque clé API donne accès à tous les modèles au sein de l’organisation.

Les clés API sont y aura pas des jetons, elles :

• ont une durée de vie illimitée et doivent être révoquées manuellement.
• ne suivent pas RFC 6750 / OAuth / JWT.

Accédez au tableau de bord des clés API

1. Connectez-vous à https://app.mindee.com
2. Dans le menu de gauche, cliquez sur « Paramètres"
3. Dans la page Paramètres, cliquez sur l’onglet « clés API ».

Ou cliquez sur ce bouton : Aller à Clés API

Création de clé API

Avant d’utiliser l’API, vous devrez créer une clé API.

Pour créer une clé API sur la plateforme Mindee :

1. Accédez au tableau de bord des clés API
2. Cliquez sur le bouton « + Créer une clé API »
3. Donnez un nom à votre clé. Vous voudrez généralement la nommer selon l’environnement, c.-à-d. dev, staging, prod, etc.
4. Cliquez sur « Créer une clé API », votre clé est désormais créée.
5. Votre nouvelle clé s’affichera, cliquez sur Copieret stockez votre clé dans un endroit sûr.

Par précaution de sécurité, vous ne y aura pas pourrez pas récupérer la clé après sa création !

Votre clé est maintenant prête à être utilisée.

Révocation/suppression de clé API

Vous pouvez révoquer une clé à tout moment en la supprimant.

Une fois une clé supprimée, elle ne peut jamais être récupérée.

Toute requête adressée à Mindee effectuée avec une clé supprimée sera rejetée, ce qui entraînera un code d’erreur HTTP 401.

Pour supprimer une clé sur la plateforme Mindee :

1. Accédez au tableau de bord des clés API
2. Vous verrez une liste de toutes vos clés API actuelles.
3. À côté de chaque clé se trouve un bouton « Supprimer », cliquez dessus.
4. Une boîte de dialogue de confirmation apparaîtra.
5. Cliquez sur « Supprimer » dans la boîte de dialogue de confirmation, votre clé est maintenant supprimée.

Utilisation d’une clé API

Lors de la création d’une clé API, veillez à copier la clé et à la stocker dans un endroit sûr.

Vous pourrez ensuite l’utiliser lors de vos appels API.

Pour plus d'informations, consultez : Configuration du client.

Bonnes pratiques pour les clés API

1. Conserver vos clés API dans vos variables d’environnement est une bonne pratique sûre.
2. Ne stockez pas votre clé API directement dans votre code, et jamais dans votre code front-end.
3. Évitez d’exposer vos clés API secrètes sur GitHub, côté client, ou dans tout autre emplacement accessible au public.
4. Si vous avez le moindre doute sur une fuite de votre clé API, supprimez-la et remplacez-la dès que possible.
5. Changez périodiquement vos clés API ; nous recommandons de les changer tous les 3 mois.

   Pour ce faire :

   1. Créez une nouvelle clé API ;
   2. Mettez à jour votre application pour utiliser la nouvelle clé API ;
   3. Supprimez l’ancienne clé API.