Sélectionner vos préférences de cookies

Nous utilisons des cookies essentiels et des outils similaires qui sont nécessaires au fonctionnement de notre site et à la fourniture de nos services. Nous utilisons des cookies de performance pour collecter des statistiques anonymes afin de comprendre comment les clients utilisent notre site et d’apporter des améliorations. Les cookies essentiels ne peuvent pas être désactivés, mais vous pouvez cliquer sur « Personnaliser » ou « Refuser » pour refuser les cookies de performance.

Si vous êtes d’accord, AWS et les tiers approuvés utiliseront également des cookies pour fournir des fonctionnalités utiles au site, mémoriser vos préférences et afficher du contenu pertinent, y compris des publicités pertinentes. Pour accepter ou refuser tous les cookies non essentiels, cliquez sur « Accepter » ou « Refuser ». Pour effectuer des choix plus détaillés, cliquez sur « Personnaliser ».

Format de fichier de clé d’API API Gateway

Mode de mise au point
Format de fichier de clé d’API API Gateway - Amazon API Gateway

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.

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.

API Gateway peut importer les clés d’API à partir de fichiers externes au format CSV (valeurs séparées par des virgules), puis associer les clés importées à un ou plusieurs plans d’utilisation. Le fichier importé doit comporter les colonnes Name et Key. Les noms d’en-tête de colonne ne sont pas sensibles à la casse et les colonnes peuvent être dans n’importe quel ordre, comme illustré dans l’exemple suivant :

Key,name apikey1234abcdefghij0123456789,MyFirstApiKey

Une valeur Key doit comprendre entre 20 et 128 caractères. Une valeur Name ne peut pas dépasser 1 024 caractères.

Un fichier de clé d’API peut également contenir la colonne Description, Enabled ou UsagePlanIds, comme illustré dans l’exemple suivant :

Name,key,description,Enabled,usageplanIds MyFirstApiKey,apikey1234abcdefghij0123456789,An imported key,TRUE,c7y23b

Lorsqu'une clé est associée à plusieurs plans d'utilisation, la UsagePlanIds valeur est une chaîne du plan d'utilisation séparée par des virgules IDs, entre guillemets doubles ou simples, comme indiqué dans l'exemple suivant :

Enabled,Name,key,UsageplanIds true,MyFirstApiKey,apikey1234abcdefghij0123456789,"c7y23b,glvrsr"

Les colonnes non reconnues sont autorisées, mais sont ignorées. La valeur par défaut est une chaîne vide ou une valeur booléenne true.

Il est possible d’importer la même clé d’API plusieurs fois, auquel cas la version la plus récente remplace la précédente. Deux clés d’API sont identiques si elles ont la même valeur key.

Note

Pour connaître les bonnes pratiques à prendre en compte, consultez Bonnes pratiques concernant les clés d’API et les plans d’utilisation.

ConfidentialitéConditions d'utilisation du sitePréférences de cookies
© 2025, Amazon Web Services, Inc. ou ses affiliés. Tous droits réservés.