Configurer l’authentification Serveur Web MID de clé API

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 2 minutes de lecture

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

    Avant de commencer

    Créez une Serveur Web MID extension pour utiliser l’authentification par clé API, comme décrit dans .Configurer l’extension Serveur Web MID Assurez-vous de sélectionner la 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 ce nombre, modifiez la valeur de la mid.webserver.max.api.keys propriété sur la page Propriétés système.

    Lorsque vous travaillez dans le domaine global, lorsque Séparation de domaine est activée, les clés API sont disponibles pour toutes les extensions, quel que soit leur domaine. Lorsque vous travaillez dans un domaine spécifique, des clés API sont disponibles pour les extensions de ce domaine, de ses domaines parents et du domaine global.

    Vous pouvez configurer les clés API pour qu’elles expirent à une date spécifiée.

    Lors de la création d’une nouvelle extension avec authentification de clé API (ou de 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 Tous > 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 du serveur Web MID.
          Tableau 1. Serveur Web MID Formulaire de clé API
          Champ Description
          Nom Nom de la clé API.
          Actives 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 tant que vous n’avez pas configuré la clé.
          Date d'expiration Option permettant de définir une date d’expiration pour la clé API.

          Les clés API expirées, désactivées ou supprimées ne sont pas acceptées par l’extension de serveur Web.
        3. Sélectionnez Soumettre pour enregistrer la clé API.

          La clé API apparaît sur la page Clés API du serveur Web MID.

      • 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 apparaît dans la boîte de dialogue Serveur Web MID.

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

          Clé <API_KEY>

          où <API_KEY> est la valeur de la clé API affichée après avoir sélectionné Afficher la clé API.
        5. Sélectionnez Envoyer.