De nombreuses API exigent que l'appelant spécifie des informations d'authentification pour la vérification de son identité et éventuellement ses droits d'accès. Les informations d'authentification peuvent être transmises via des en-têtes HTTP (authentification basique/NTLM/Digest ), en échangeant des jetons d'accès (OAuth), en demandant au client d'inclure un certificat client dans la requête, ou via une combinaison de ces méthodes.

Cet article présente les options pour les certificats client. Pour configurer les méthodes d'authentification traditionnelles, lisez l'article sur les types d'authentification.

Les types de certificats client

La section Certificats client de l'onglet Étapes d'un moniteur d'API multi-étapes propose les options suivantes. Si vous utilisez plusieurs étapes dans votre définition, assurez-vous d'avoir les paramètres nécessaires pour chaque étape.

  • Certificat client d'Uptrends : Cette option est utile si vous demandez à vos utilisateurs d'API de générer et d'inclure leur propre certificat client pour prouver leur identité. Si vous choisissez cette option, un certificat appartenant à Uptrends sera fourni lors de l'envoi de la requête HTTP. Votre API peut vérifier cette requête entrante en utilisant la clé publique correspondante. S'il y a correspondance, alors c'est une preuve que la requête provient de quelqu'un qui possède le certificat d'origine (c.à.d. Uptrends), et personne d'autre. Pour plus d'informations, lisez l'article sur Information sur les clés publiques d'Uptrends.
  • Certificat client personnalisé : Utilisez cette option lorsque vous possédez ou contrôlez le certificat client qui doit être inclus dans la requête. Une fois que vous avez téléchargé le fichier de certificat à Uptrends, vous pouvez l'inclure dans vos moniteurs d'API multi-étapes. Puisque       ce certificat vous appartient, votre API pourra vérifier les requêtes entrantes qui l'utilisent. Lisez la section suivante pour la configuration.
  • Aucun : Choisissez Aucun si vous ne voulez pas inclure de certificat client dans votre requête HTTP.

Création d'un certificat client personnalisé

Avant d'inclure un certificat client dans vos moniteurs d'API multi-étapes, vous devez d'abord le télécharger vers votre compte Uptrends. Les certificats (et autres informations sensibles) sont téléchargés et stockés dans votre coffre-fort. Une fois que vous avez placé un certificat dans votre coffre-fort, vous pouvez commencer à l'utiliser dans la configuration de votre moniteur.

Téléchargement d'un certificat client

Lorsque vous choisissez l'option Certificat client personnalisé pour la première fois, vous remarquerez qu'il n'y a pas encore de certificats disponibles. Pour en ajouter un, choisissez Ajouter un certificat, puis vous serez dirigé vers le coffre-fort. Autrement, choisissez Compte> Coffre-fort dans le menu principal, et cliquez sur Ajouter un élément de coffre-fort. Dans la fenêtre Nouvel élément de coffre-fort donnez un nom unique au certificat afin de pouvoir le reconnaître plus tard. Assurez-vous que le Type du nouvel élément du coffre-fort est Archive de certificats. Rajoutez éventuellement les notes que vous souhaitez ajouter dans le champ Description. Enfin, spécifiez le fichier de certificat que vous voulez télécharger. Le fichier doit être de type PKCS#12, ou un fichier d'archive de certificat, qui contient à la fois la clé privée et la clé publique. Les fichiers PKCS #12 ont une extension .pfx ou .p12. Un fichier d'archive de certificat est souvent crypté, nous avons donc besoin du mot de passe correspondant pour pouvoir l'utiliser. Merci de spécifier le mot de passe dans le champ Mot de passe d'archivage, puis cliquez sur Enregistrer.

Utilisation d'un certificat client dans un moniteur d'API multi-étapes

Dès que vous avez enregistré un certificat client dans le coffre-fort, vous pouvez commencer à l'utiliser dans un moniteur API multi-étapes. Dans la section Certificat client d'une étape, vous pouvez cliquer sur Actualiser pour recharger la liste des certificats disponibles. Pour finir, utilisez le certificat de votre choix dans chaque étape qui en a besoin.