APIFormato del file API della chiave Gateway

APIGateway può importare API chiavi da file esterni in un formato con valori separati da virgole (CSV) e 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

Un Key valore deve essere compreso tra 20 e 128 caratteri. Un valore Name non può superare 1024 caratteri.

Un file API chiave può anche avere la UsagePlanIds colonna DescriptionEnabled, o, come illustrato 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 UsagePlanIds valore è una stringa separata da virgole del piano di utilizzoIDs, racchiusa tra un paio di virgolette doppie o singole, come illustrato 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 API chiave può essere importata più volte, con la versione più recente che sovrascrive quella precedente. Due API chiavi sono identiche se hanno lo stesso key valore.