Configurer l'authentification de clé API de l'extension Serveur Web MID

Authentifiez les demandes entrantes des clients vers l'extension Serveur Web MID à l'aide de l'authentification de clé API. L'authentification API est un moyen sécurisé et simple d'authentifier votre demande. Vous pouvez créer ou modifier la clé API d'une extension Serveur Web MID.

Avant de commencer

Créez une extension Serveur Web MID pour utiliser l'authentification de clé API, comme décrit à la rubrique Configurer l'extension Serveur Web MID. Veillez à sélectionner Clé API dans le champ Type d'authentification de l'extension.

Rôle requis : event_mgmt_admin

Pourquoi et quand exécuter cette tâche

Par défaut, le nombre maximal de clés API que vous pouvez créer sur une instance est de 10. Pour modifier cette valeur, modifiez la valeur de la propriété mid.webserver.max.api.keys sur la page Propriétés système.

Lorsque vous utilisez le domaine global alors que l'application Domain Separation est activée, les clés API sont disponibles pour toutes les extensions, quel que soit leur domaine. Lorsque vous utilisez un domaine spécifique, les clés API sont disponibles pour les extensions dans ce domaine, ses domaines parents et le domaine global.

Vous pouvez configurer les clés API pour qu'elles expirent à une date spécifique.

Lors de la création d'une nouvelle extension avec l'authentification de clé API (ou la mise à jour d'une extension existante pour utiliser l'authentification de clé API), le système recherche une clé API disponible pour l'extension. Si aucune clé API n'est disponible, le système en crée une.

Procédure

1. Accédez à la Tout > Serveur MID > Profils et déploiements > Clé API du serveur Web MID.
2. Créez une nouvelle clé API ou modifiez une clé API existante.
   • Pour créer une nouvelle clé API :
     1. Sélectionnez Nouveau.
     2. Renseignez les champs du formulaire Clé API de l'extension MID Web Server.

        Tableau 1. Formulaire Clé API de l'extension Serveur Web MID

        Champ	Description
        Nom	Nom de la clé API.
        Active	Option d'activation de la clé API.
        Clé d'authentification	Valeur codée en lecture seule de la clé d'authentification. Aucune valeur ne s'affiche avant la configuration de la clé.
        Date d'expiration	Option permettant de définir une date d'expiration de la clé API. Les clés API qui ont expiré, qui sont désactivées ou qui ont été supprimées ne sont pas prises en charge par l'extension MID Web Server.

     3. Sélectionnez Envoyer pour enregistrer la clé API.

        La clé API figure sur la page Clés API de l'extension MID Web Server.

   • Pour modifier une clé API existante :
     1. Accédez à la Serveur MID > Profils et déploiements > Clé API du serveur Web MID.
     2. Sélectionnez une clé API sur la page.
     3. Dans la section Liens connexes, sélectionnez Afficher la clé API.
     4. Copiez la clé API qui se trouve dans la boîte de dialogue MID Web Server.

        Lors de la connexion à une extension Serveur Web MID configurée avec l'authentification de clé API, placez une clé API à laquelle l'extension a accès dans l'en-tête Autorisation de la demande au format suivant :

        Clé <CLÉ_API>

        où <CLÉ_API> correspond à la valeur de clé API affichée après avoir sélectionné Afficher la clé API.
     5. Sélectionnez Envoyer.