Configuration des clés d'API à l'aide de l'API REST API Gateway

Pour configurer les clés API, procédez comme suit :

• Configurez des méthodes API pour exiger une clé API.

• Créez ou importez une clé API pour l'API dans une région.

Avant de configurer des clés API, vous devez avoir créé une API et l'avoir déployée jusqu'à une étape. Une fois que vous avez créé une valeur de clé d'API, elle ne peut pas être modifiée.

Pour que les appels d'API REST créent et déploient une API, veuillez consulter les sections restapi:create et deployment:create, respectivement.

Note

Pour connaître les meilleures pratiques à prendre en compte, voirBonnes pratiques concernant les clés d'API et les plans d'utilisation.

Exigence d'une clé API sur une méthode

Pour exiger une clé API sur une méthode, exécutez l'une des actions suivantes :

• Appelez method:put pour créer une méthode. Définissez apiKeyRequired sur true dans la charge utile de la demande.

• Appelez method:update pour définir apiKeyRequired sur true.

Création ou importation de clés API

Pour créer ou importer une clé API, exécutez l'une des actions suivantes :

• Appelez apikey:create pour créer une clé d'API.

• Appelez apikey:import pour importer une clé d'API à partir d'un fichier. Pour le format de fichier, consultez Format de fichier de clé d'API API Gateway.

Vous ne pouvez pas modifier la valeur de la nouvelle clé d'API. Pour découvrir comment configurer un plan d'utilisation, consultez Création, configuration et test des plans d'utilisation avec l'interface de ligne de commande API Gateway et l'API REST.