Gestion des clés d'API dans Mindee

La création d'une clé d'API est l'une des toutes premières étapes qu'un utilisateur doit effectuer avant de faire une demande d'API ou d'appeler les API Mindee. Nous avons récemment modifié la façon dont les clés d'API sont créées afin de permettre aux utilisateurs de les gérer facilement.

Qu'est-ce qui a changé ?

Auparavant, les clés d'API étaient créées directement dans l'API que vous souhaitiez utiliser à partir des boutiques d'API Mindee. Par exemple, si vous souhaitez accéder à l'API Receipts, vous devez créer une clé API, qui ne fonctionnera que pour l'API Receipts et aucune autre API. Si vous deviez accéder à l'API Invoices, vous devrez créer une autre clé API pour cela.

Chaque fois qu'un utilisateur souhaite utiliser une API différente, il doit revenir sur la plateforme et générer une nouvelle clé API.

Cependant, avec cette version, nous avons permis aux utilisateurs d'accéder à toutes les API de l'APIs Store à l'aide d'une seule clé d'API. C'est exact ; une clé API peut vous donner accès à l'API Invoices, à l'API Receipts, etc. Vous n'aurez pas besoin de créer une nouvelle clé API pour chaque API à laquelle vous souhaitez accéder.

Comment créer une clé API ?

Une fois connecté, vous arriverez sur la page du hub des API où vous pourrez voir Vos API et les API prêtes à l'emploi dans le Boutique d'API

1. Cliquez sur votre nom d'utilisateur ou le nom de votre organisation en haut à droite de la page.
2. Sélectionnez Paramètres dans le menu déroulant.
3. Cliquez sur les clés API sur le côté gauche de la page du tableau de bord des paramètres.
4. Cliquez sur Création d'une nouvelle clé API bouton.
5. Donnez le nom souhaité à votre clé API et cliquez sur Créer une clé API.
6. Votre clé API sera créée avec la date et l'heure de création. Vous pouvez ensuite copier votre clé API et la coller dans vos environnements de codage, vos applications ou vos outils de ligne de commande.

Clés d'API multiples

Dans la section Clés API, qui se trouve désormais dans les paramètres de votre compte, vous pouvez créer plusieurs clés API en fonction de vos besoins. Vous trouverez de plus amples informations dans le Documentation Mindee.

Qu'arrive-t-il à mes clés d'API existantes ?

Pour les utilisateurs qui ont déjà créé et utilisé des clés d'API, une migration a été effectuée afin que vos clés d'API soient désormais disponibles sous votre Paramètres du compte. L'utilisation de ces clés existantes n'est plus limitée à l'API pour laquelle elles ont été créées, elles peuvent désormais être utilisées pour accéder à toutes les API disponibles dans le Mindee API Store.

Examinons cet exemple pour mieux comprendre ce qu'il advient de vos clés d'API existantes : en supposant que vous utilisiez une clé d'API que vous avez créée avec le nom clé d'API de facturation pour accéder à l'API Invoices et à une clé API portant le nom clé API de réception pour accéder à l'API Receipts. L'image ci-dessous montre comment elle était précédemment affichée sur la plateforme.

Avec la récente mise à jour, l'image ci-dessous montre comment elle s'affiche actuellement.

Le clé d'API de facturation peut désormais être utilisé pour accéder à l'API des factures, à l'API des reçus et à toutes les autres API disponibles depuis le Mindee API Store. Il en va de même pour clé API de réception.

Remarque: Cela s'applique uniquement aux API présentes dans les boutiques d'API Mindee, et non à vos API personnalisées

Cette modification de la gestion des clés d'API est rétrocompatible, ce qui signifie qu'elle n'a aucun impact sur la façon dont votre clé existante fonctionnait par le passé. Vous n'avez rien à modifier dans votre code car cette mise à jour n'affectera pas le processus d'authentification, mais simplifiera plutôt le fonctionnement des API à l'avenir.

Photo de Kelly Sikkema sur Unsplash