API-Schlüsseldateiformat in API Gateway

API Gateway kann API-Schlüssel aus externen Dateien im CSV-Format importieren und die Schlüssel dann einem oder mehreren Nutzungsplänen zuordnen. Die importierte Datei muss die Spalten Name und Key aufweisen. Bei Spaltenüberschriften wird z. B. die Groß-/Kleinschreibung nicht beachtet und die Spaltenreihenfolge ist beliebig:

Key,name
apikey1234abcdefghij0123456789,MyFirstApiKey

Ein Key-Wert muss zwischen 20 und 128 Zeichen lang sein. Ein Name-Wert darf nicht mehr als 1024 Zeichen enthalten.

Eine API-Schlüsseldatei kann z. B. auch die Spalten Description, Enabledoder UsagePlanIds aufweisen:

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

Ist ein Schlüssel z. B. mehreren Nutzungsplänen zugeordnet, handelt es sich bei dem UsagePlanIds-Wert um eine CSV-Zeichenfolge, die die Nutzungsplan-IDs in (einfachen oder doppelten) Anführungszeichen angibt:

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

Nicht erkannte Spalten sind zulässig, werden aber ignoriert. Der Standardwert ist eine leere Zeichenfolge oder ein boolescher true-Wert.

Derselbe API-Schlüssel kann mehrmals importiert werden, dabei überschreibt die neueste Version die vorherige. Zwei API-Schlüssel sind identisch, wenn sie den gleichen key-Wert haben.