APIFormat de fichier API clé de passerelle

APIGateway peut importer des API clés à partir de fichiers externes au format valeur séparée par des virgules (CSV), 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 Key valeur doit comporter entre 20 et 128 caractères. Une valeur Name ne peut pas dépasser 1 024 caractères.

Un fichier API clé peut également comporter la UsagePlanIds colonne DescriptionEnabled, ou, 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 virgulesIDs, 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.

La même API clé peut être importée plusieurs fois, la version la plus récente remplaçant la précédente. Deux API clés sont identiques si elles ont la même key valeur.