Formato file chiave API di API Gateway

API Gateway può importare le chiavi API dai file esterni in formato CSV (comma-separated value), quindi associare le chiavi importate a uno o più piani di utilizzo. Il file importato deve contenere le colonne Name e Key. Per i nomi delle intestazioni di colonna non viene rilevata la distinzione tra maiuscole e minuscole e le colonne possono essere disposte in qualsiasi ordine, come mostrato nel'esempio seguente:

Key,name
apikey1234abcdefghij0123456789,MyFirstApiKey

Il valore di Key deve essere costituito da un numero di caratteri compreso tra 20 e 128. Un valore Name non può superare 1024 caratteri.

Un file di chiavi API può includere anche la colonna Description, Enabled o UsagePlanIds, come mostrato nell'esempio seguente:

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

Quando una chiave è associata a più di un piano di utilizzo il valore UsagePlanIds è una stringa separata da virgole di ID di piani di utilizzo racchiusi tra una coppia di apici singoli o doppi, come mostrato nell'esempio seguente:

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

Le colonne non riconosciute sono consentite ma vengono ignorate. Il valore predefinito è una stringa vuota o il valore booleano true.

La stessa chiave API può essere importata più volte e la versione più recente sovrascrive la precedente. Due chiavi API sono identiche se hanno lo stesso valore key.