Authentification des demandes d'API

Vous pouvez authentifier les demandes d'API dans webMethods Integration en utilisant des clés API personnelles ou d'identification de service pour un accès et une intégration sécurisés.

Avant de commencer

Pour créer des clés API, vous devez avoir un rôle d'administrateur de service.

A propos de cette tâche

webMethods Integration utilise des clés d'API pour authentifier vos demandes d'API sur HTTP. Une clé API est un identifiant unique utilisé pour authentifier et autoriser l'accès à une interface de programmation d'applications (API).
Les clés API peuvent être classées dans les catégories suivantes en fonction de leur utilisation et de leur niveau d'accès :
  • Personnels. La clé API personnelle fonctionne en fonction du rôle et des autorisations de l'utilisateur. Il donne l'accès en fonction de ce que l'utilisateur est autorisé à faire.
  • Service ID. La clé API Service ID n'est associée à aucun utilisateur. Il fonctionne sur la base de l'identifiant de service auquel il appartient.
    Remarque : Lors de l'authentification des demandes d'API publiques, une clé API d'identification de service ne prend en charge que les cas d'utilisation d'exécution et n'autorise pas les opérations CRUD (création, lecture, mise à jour, suppression). Pour effectuer des opérations CRUD, vous devez utiliser une clé API personnelle.

Vous créez des clés API à l'aide de la console IBM SaaS. Avant de pouvoir générer une clé API pour une application ou un service, vous devez créer un identifiant de service pour cette application ou ce service dans la console IBM SaaS.

Procédure

  1. Pour créer une clé API dans webMethods Integration, accédez au menu principal depuis la page d'accueil.
  2. Sélectionnez Gestion de l'accès pour ouvrir la console IBM SaaS.
  3. Choisissez votre abonnement.
  4. Sur la page Abonnements, cliquez sur Voir les instances.
  5. Dans le tableau de l'onglet Instances, cliquez sur la ligne de l'instance où vous souhaitez ajouter la clé API.
    La page des détails de l'instance s'affiche avec les onglets Service IDs et API Keys.
  6. Allez dans l'onglet Service IDs pour créer les identifiants de service et dans l'onglet API Keys pour générer les clés API.

    Pour savoir comment créer des clés API et des identifiants de service dans la console SaaS, voir Octroi d'un accès par le biais d'identifiants de service et de clés API à partir de la console IBM SaaS.

Etape suivante

Une fois les clés générées, configurez les détails de l'autorisation dans le client externe pour accéder et interagir avec le webMethods Integration.

Par exemple, si vous utilisez un client externe tel que Postman, définissez le type d' autorisation sur Clé API. Utilisez X-INSTANCE-API-KEY comme nom de clé et fournissez la clé API générée en utilisant la console SaaS comme valeur de clé. Postman inclut l'adresse X-INSTANCE-API-KEY dans l'en-tête de la requête HTTP, qui sert d'identifiant pour authentifier la requête entrante. Si vous utilisez un autre client HTTP, transmettez l'en-tête X-INSTANCE-API-KEY sous la forme d'un en-tête HTTP et définissez la clé API comme valeur. La clé agit comme un mot de passe pour vérifier l'identité du client et s'assurer qu'il a le droit d'accéder aux données ou aux services.