Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Configuration des API clés à l'aide de la console API Gateway
Pour configurer API les clés, procédez comme suit :
Configurez les API méthodes pour exiger une API clé.
Créez ou importez une API clé pour le API dans une région.
Avant de configurer API les clés, vous devez en avoir créé une API et l'avoir déployée sur une scène. Une fois que vous avez créé une valeur API clé, elle ne peut pas être modifiée.
Pour obtenir des instructions sur la création et le déploiement d'un à API l'aide de la console API Gateway, reportez-vous Développez REST APIs dans API Gateway aux sections etDéploiement REST APIs dans API Gateway, respectivement.
Après avoir créé une API clé, vous devez l'associer à un plan d'utilisation. Pour plus d’informations, consultez Créez, configurez et testez des plans d'utilisation avec la console API Gateway.
Note
Pour connaître les bonnes pratiques à prendre en compte, consultez Bonnes pratiques en matière de API clés et de plans d'utilisation.
Exiger une API clé pour une méthode
La procédure suivante décrit comment configurer une API méthode pour exiger une API clé.
Pour configurer une API méthode nécessitant une API clé
Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway
. Choisissez un RESTAPI.
-
Dans le volet de navigation principal de API Gateway, sélectionnez Resources.
-
Sous Resources, créez une méthode ou choisissez une méthode existante.
-
Dans l'onglet Demande de méthode, sous Paramètres de demande de méthode, choisissez Modifier.
-
Sélectionnez APIla clé requise.
-
Choisissez Enregistrer.
-
Déployez ou redéployez le API pour que l'exigence prenne effet.
Si l'option APIclé requise est définie sur false et que vous n'exécutez pas les étapes précédentes, aucune API clé associée à une API étape n'est utilisée pour la méthode.
Création d'une API clé
Si vous avez déjà créé ou importé des API clés à utiliser avec des plans d'utilisation, vous pouvez ignorer cette procédure ainsi que la suivante.
Pour créer une clé API
Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway
. Choisissez un RESTAPI.
-
Dans le volet de navigation principal de API Gateway, choisissez APIles clés.
-
Choisissez Créer une API clé.
-
Pour Nom, entrez un nom.
(Facultatif) Sous Description, entrez une description.
-
Pour APIla clé, choisissez Auto generate pour que API Gateway génère la valeur clé, ou choisissez Custom pour créer votre propre valeur clé.
-
Choisissez Enregistrer.
APIClés d'importation
La procédure suivante décrit comment importer des API clés à utiliser avec les plans d'utilisation.
Pour importer des API clés
Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway
. Choisissez un RESTAPI.
-
Dans le volet de navigation principal, choisissez APIles touches.
-
Choisissez le menu déroulant Actions, puis choisissez Importer des API clés.
-
Pour charger un fichier de clés séparées par des virgules, choisissez Choisissez un fichier. Vous pouvez également entrer les clés dans l'éditeur de texte. Pour plus d'informations sur le format de fichier, consultez APIFormat de fichier API clé de passerelle.
-
Choisissez Échouer avec les avertissements pour arrêter l'importation en cas d'erreur, ou Ignorer les avertissements pour continuer à importer les entrées de clé valides en cas d'avertissement.
-
Choisissez Importer pour importer vos API clés.
