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.
En fonction du type de source de la clé d’API que vous choisissez, appliquez l’une des procédures suivantes pour utiliser une clé d’API issue de l’en-tête ou une clé d’API renvoyée par un mécanisme d’autorisation dans l’appel de méthode :
Pour utiliser une clé d’API issue d’un en-tête :
-
Créez une API avec les méthodes d'API souhaitées, puis déployez l'API dans une étape.
-
Créez un nouveau plan d'utilisation ou choisissez un plan d'utilisation existant. Ajoutez l'étape d'API déployée au plan d'utilisation. Attachez une clé API au plan d'utilisation ou choisissez une clé API existante dans le plan. Notez la valeur de clé API choisie.
-
Configurez des méthodes d’API pour exiger une clé API.
-
Redéployez l'API à la même étape. Si vous déployez l'API pour une nouvelle étape, assurez-vous de mettre à jour le plan d'utilisation pour attacher la nouvelle étape d'API.
-
Appelez l’API à l’aide de la clé d’API. L’exemple de commande curl suivant invoque la méthode
GETsur la ressourcegetUsersde l’étapeprodd’une API à l’aide d’une clé d’API.curl -H "X-API-Key: abcd1234" 'https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers'
Le client peut désormais appeler les méthodes d’API tout en fournissant l’en-tête x-api-key avec la clé API choisie comme valeur d’en-tête. Un appel peut se présenter comme suit :
Pour utiliser une clé d’API issue d’un mécanisme d’autorisation :
-
Créez une API avec les méthodes d'API souhaitées, puis déployez l'API dans une étape.
-
Créez un nouveau plan d'utilisation ou choisissez un plan d'utilisation existant. Ajoutez l'étape d'API déployée au plan d'utilisation. Attachez une clé API au plan d'utilisation ou choisissez une clé API existante dans le plan. Notez la valeur de clé API choisie.
-
Créez un mécanisme d’autorisation Lambda par jeton. Incluez,
usageIdentifierKey:en tant que propriété de niveau racine de la réponse d’autorisation. Pour apprendre à créer un mécanisme d’autorisation par jeton, consultez Exemple de fonction de mécanisme d’autorisation Lambda TOKEN.{api-key} -
Configurez des méthodes d’API pour exiger une clé d’API et activer le mécanisme d’autorisation Lambda sur les méthodes.
-
Redéployez l'API à la même étape. Si vous déployez l'API pour une nouvelle étape, assurez-vous de mettre à jour le plan d'utilisation pour attacher la nouvelle étape d'API.
Le client peut désormais appeler les méthodes API key-required sans fournir explicitement une clé API. La clé API retournant le mécanisme d’autorisation est utilisée automatiquement.
