Formato de archivo de clave de API de API Gateway

API Gateway puede importar claves de API de archivos externos con un formato de valores separados por comas (CSV) y asociar las claves importadas a uno o varios planes de uso. El archivo importado debe contener las columnas Name y Key. Los nombres de encabezado de columna no distinguen entre mayúsculas y minúsculas y las columnas pueden estar en cualquier orden, tal y como se muestra en el ejemplo siguiente:

Key,name
apikey1234abcdefghij0123456789,MyFirstApiKey

Un valor Key debe estar comprendido entre 20 y 128 caracteres. Un valor Name no puede superar los 1024 caracteres.

Un archivo de claves de API puede tener las columnas Description, Enabledo UsagePlanIds, como se muestra en el ejemplo siguiente:

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

Cuando una clave está asociada a varios planes de uso, el valor de UsagePlanIds es una cadena separada por comas con los identificadores del plan de uso incluidos entre comillas simples o dobles, tal y como se muestra en el ejemplo siguiente:

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

Se pueden usar columnas no reconocidas, pero se omitirán. El valor predeterminado es una cadena vacía o un valor booleano true.

Se puede importar varias veces la misma clave de API, pero la versión más reciente sobrescribirá la anterior. Dos claves de API son idénticas si tienen el mismo valor de key.

nota

Para conocer las prácticas recomendadas a tener en cuenta, consulte Prácticas recomendadas para claves de API y planes de uso.