Configurer la clé API : authentification basée sur les jetons

Configurez une clé API pour prendre en charge l’authentification des points de terminaison REST API.

Avant de commencer

Rôle requis : administrateur

Module d’extension requis : clé API et authentification HMAC (com.glide.tokenbased_auth)

Procédure

1. Créez un profil d’authentification entrant.
   1. Accédez à la Tout > Services web du système > Politiques d'accès API > Profils d’authentification entrants.
   2. Sélectionnez Nouveau.
      Le système affiche le message Quel type de profil d’authentification ?
   3. Sélectionnez Créer des profils d’authentification de clé API.
      
   4. Renseignez les champs du formulaire.

      Tableau 1. Profils d’authentification de clé API

      Champ	Description
      Nom	Nom permettant d’identifier la politique d’authentification.
      Application	Périmètre de la politique d’authentification.
      Paramètre d'authentification	Sélectionnez le paramètre d’authentification pour la demande d’authentification. Vous pouvez sélectionner les options par défaut ou créer un nouveau paramètre d’authentification : x-sn-apikey : en-tête d’authentification x-sn-apikey : en-tête du paramètre de requête

      Remarque :

      L’option sélectionnée doit être définie dans l’appel REST dans le cadre de l’en-tête d’authentification ou du paramètre de requête.

      
   5. Envoyez le formulaire.
2. Créez une clé API REST.
   1. Accédez à la Tout > Services web du système > Politiques d'accès API > Clé API REST.
   2. Sélectionnez Nouveau.
   3. Renseignez les champs du formulaire :

      Tableau 2. Clé API

      Champ	Description
      Nom	Nom permettant d’identifier la clé API REST
      Description	Description de la clé API REST.
      Actif	État de la clé API REST.
      Utilisateur	Utilisateur associé à la clé API REST. Utilisez l’icône de recherche pour sélectionner l’utilisateur.
      Périmètre d'authentification	Option permettant d’ajouter un périmètre d’authentification pour gérer l’autorité de la clé API REST.
      Jeton	Clé API REST générée par le Now Platformfichier . Copiez la clé à utiliser dans le cadre de l’appel d’API REST dans le paramètre En-tête ou Requête.
      Expiration	Heure après laquelle les informations d’identification ne sont plus valides. Une valeur vide signifie qu’il n’y a pas d’expiration. Remarque : Pour plus d’informations sur l’expiration du jeton, reportez-vous à la section Nettoyage de l’expiration du jeton .

   4. Envoyez le formulaire.
   5. Ouvrez l’enregistrement qui a été créé pour afficher le jeton généré par l’utilisateur Now Platform .
      
3. Créez une politique d’accès REST API.
   1. Accédez à la Tout > Services web du système > Politiques d'accès REST API.
   2. Sélectionnez Nouveau.
   3. Renseignez les champs du formulaire.

      Tableau 3. Politiques d'accès API

      Champ	Description
      Nom	Nom unique de la politique d’accès à l’API.
      Actif	Option permettant d’activer la politique d’accès API.
      API REST	L’API REST à laquelle la politique d’accès est appliquée. Par exemple, API de pièce jointe.
      CHEMIN REST API	Chemin d’accès de l’API de REST. Ce champ est renseigné automatiquement en fonction de l’API REST sélectionnée. Par exemple, now/attachment.
      Fonction de message REST	Méthode utilisée pour interagir avec l’API. Ce champ est renseigné automatiquement en fonction de l’API REST sélectionnée.
      Version	Version de l'API. Par exemple, v1. Ce champ est renseigné automatiquement en fonction de l’API REST sélectionnée. Remarque : Si vous souhaitez créer une politique d’authentification pour toutes les versions d’une REST API, vous devez créer des politiques individuelles pour chaque version.
      Ressource	Ressource enfant de l’API REST. Ce champ est renseigné automatiquement en fonction de l’API REST sélectionnée. Par exemple, /now/attachment
      Application	Périmètre de l'application.
      Global	Activez ce champ pour appliquer la politique d’authentification à toutes les méthodes, versions et ressources de l’API. Remarque : L’authentification basée sur le jeton n’est pas autorisée dans la politique API REST globale.
      Appliquer à toutes les méthodes	Activez ce champ pour appliquer la politique d’authentification de l’API à toutes les méthodes, versions et ressources de l’API.
      Appliquer à toutes les ressources	Activez ce champ pour appliquer la politique d’authentification de l’API à toutes les versions.
      Appliquer à toutes les versions	Activez ce champ pour appliquer la politique d’authentification de l’API à toutes les ressources.

      
   4. Ajoutez le profil d’authentification API qui a été créé.
   5. Envoyez le formulaire.
   Vous pouvez envoyer l’appel d’API REST avec le x-sn-apikey (jeton) qui a été généré par lors Now Platform de la création de la clé API dans le paramètre En-tête ou Requête en fonction de la configuration de l’authentification.

   Avertissement :

   Utilisez la demande POST lorsque vous soumettez des informations sensibles au serveur.