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 clés d'API pour REST APIs dans API Gateway
Pour configurer les clés d’API, procédez comme suit :
+ Configurez des méthodes API pour exiger une clé d’API.
+ Créez ou importez une clé d’API pour l’API dans une région.
Avant de configurer des clés d’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 obtenir les instructions de création et de déploiement d’une API à l’aide de la console API Gateway, consultez [Développez REST APIs dans API Gateway](rest-api-develop.md) et [Déploiement d’une API REST dans API Gateway](how-to-deploy-api.md), respectivement.
Une fois votre clé d’API créée, vous devez l’associer à un plan d’utilisation. Pour de plus amples informations, veuillez consulter [Configurer des plans d'utilisation pour REST APIs dans API Gateway](api-gateway-create-usage-plans.md).
**Note**
Pour connaître les meilleures pratiques à prendre en compte, voir[Bonnes pratiques concernant les clés d’API et les plans d’utilisation](api-gateway-api-usage-plans.md#apigateway-usage-plans-best-practices).
**Topics**
+ [Exigence d'une clé d’API sur une méthode](#api-gateway-usage-plan-configure-apikey-on-method)
+ [Création d’une clé d’API](#api-gateway-usage-plan-create-apikey)
+ [Importation de clés d’API](#api-gateway-usage-pan-import-apikey)
## Exigence d'une clé d’API sur une méthode
La procédure suivante explique comment configurer une méthode d’API pour exiger une clé d’API.
------
#### [ AWS Management Console ]
**Pour configurer une méthode d’API pour exiger une clé d’API**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Choisissez une API REST.
1. Dans le panneau de navigation principal d’API Gateway, choisissez **Resources (Ressources)**.
1. Sous **Resources**, créez une méthode ou choisissez une méthode existante.
1. Dans l'onglet **Demande de méthode**, sous **Paramètres de demande de méthode**, choisissez **Modifier**.
![\[Ajout d’une clé d’API à une méthode\]](http://docs.aws.amazon.com/fr_fr/apigateway/latest/developerguide/images/api-gateway-new-console-add-key-to-method.png)
1. Sélectionnez **Clé d’API obligatoire**.
1. Choisissez **Enregistrer**.
1. Déployez ou redéployez l’API pour que l’exigence prenne effet.
Si l’option **Clé d’API obligatoire** est définie sur `false` et que vous n’exécutez pas les étapes précédentes, aucune clé d’API associée à une étape d’API n’est utilisée pour la méthode.
------
#### [ AWS CLI ]
La commande [put-method](https://docs.aws.amazon.com/cli/latest/reference/apigateway/put-method.html) suivante crée une méthode `PUT` qui nécessite une clé d’API :
```
aws apigateway put-method \
--rest-api-id 1234123412 \
--resource-id a1b2c3 \
--http-method PUT \
--authorization-type "NONE" \
--api-key-required
```
La commande [update-method](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-method.html) suivante met à jour une méthode existante pour qu’elle exige une clé d’API :
```
aws apigateway update-method \
--rest-api-id 1234123412 \
--resource-id a1b2c3 \
--http-method PUT \
--patch-operations op="replace",path="/apiKeyRequired",value="true"
```
------
#### [ REST API ]
Pour exiger une clé d’API sur une méthode, exécutez l’une des actions suivantes :
+ Appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_PutMethod.html](https://docs.aws.amazon.com/apigateway/latest/api/API_PutMethod.html) pour créer une méthode. Définissez `apiKeyRequired` sur `true` dans la charge utile de la demande.
+ Appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateMethod.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateMethod.html) pour définir `apiKeyRequired` sur `true`.
------
## Création d’une clé d’API
La procédure suivante montre comment créer une clé d’API. Si vous désirez importer votre clé d’API, ignorez cette étape.
------
#### [ AWS Management Console ]
**Pour créer une clé d’API**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Choisissez une API REST.
1. Dans le panneau de navigation principal d’API Gateway, choisissez **Clés d’API**.
1. Choisissez **Créer une clé d’API**.
![\[Création de clés d’API pour les plans d’utilisation\]](http://docs.aws.amazon.com/fr_fr/apigateway/latest/developerguide/images/api-gateway-new-console-usage-plan-keys-choose-create-api-key-from-actions-menu.png)
1. Pour **Nom**, entrez un nom.
1. (Facultatif) Sous **Description**, entrez une description.
1. Pour **Clé d’API**, choisissez **Autogénérer** pour qu’API Gateway génère la valeur de la clé, ou choisissez **Personnalisé** pour créer votre propre valeur de clé.
1. Choisissez **Enregistrer**.
------
#### [ AWS CLI ]
La [create-api-key](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html)commande suivante crée une clé d'API :
```
aws apigateway create-api-key \
--name 'Dev API key' \
--description 'API key for Devs' \
--enabled
```
------
#### [ REST API ]
Appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_CreateApiKey.html](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateApiKey.html) pour créer une clé d’API.
------
## Importation de clés d’API
La procédure suivante explique comment importer des clés d’API. Si vous avez déjà créé une clé d’API, ignorez cette étape.
------
#### [ AWS Management Console ]
**Pour importer des clés d’API**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Choisissez une API REST.
1. Dans le panneau de navigation principal, choisissez **Clés d’API**.
1. Choisissez le menu déroulant **Actions**, puis choisissez **Importer des clés d’API**.
1. Pour charger un fichier de clés séparées par des virgules, sélectionnez **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 [Format de fichier de clé d’API API Gateway](api-key-file-format.md).
1. 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.
1. Choisissez **Importer** pour importer vos clés d’API.
------
#### [ AWS CLI ]
La [import-api-keys](https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-api-keys.html)commande suivante importe une clé d'API :
```
aws apigateway import-api-key \
a--body fileb://keys.csv \
--format csv
```
------
#### [ REST API ]
Appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_ImportApiKeys.html](https://docs.aws.amazon.com/apigateway/latest/api/API_ImportApiKeys.html) 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](api-key-file-format.md).
------
Vous ne pouvez pas modifier la valeur de la nouvelle clé d’API. Une fois votre API créée, vous allez configurer un plan d’utilisation. Pour de plus amples informations, veuillez consulter [Configurer des plans d'utilisation pour REST APIs dans API Gateway](api-gateway-create-usage-plans.md).