Configuración de claves de API mediante la consola de API Gateway
Para configurar las claves de API, haga lo siguiente:
Configure los métodos de la API para que exijan una clave de API.
Cree o importe una clave de API para la API de una región.
Antes de configurar las claves de API, debe haber creado una API y haberla implementado hasta una fase. Después de crear un valor de clave de API, no se puede cambiar.
Para obtener instrucciones acerca de cómo crear e implementar una API a través de la consola de API Gateway, consulte Desarrollo de las API de REST en API Gateway y Implementación de las API de REST en API Gateway, respectivamente.
Después de crear una clave de API, debe asociarla al plan de uso. Para obtener más información, consulte Creación, configuración y prueba de los planes de uso con la consola de API Gateway.
nota
Para conocer las prácticas recomendadas a tener en cuenta, consulte Prácticas recomendadas para claves de API y planes de uso.
Exigir una clave de API en un método
El siguiente procedimiento describe cómo configurar un método de API para exigir una clave de API.
Para configurar un método de API para exigir una clave de API
Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway
. Elija una API de REST.
-
En el panel de navegación principal de API Gateway, elija Resources (Recursos).
-
En Resources (Recursos), cree un método nuevo o elija uno existente.
-
En la pestaña Solicitud de método, en Configuración de solicitud de método, elija Editar.
-
Seleccione Clave de API obligatoria.
-
Seleccione Guardar.
-
Implemente o redistribuya la API para que el requisito surta efecto.
Si la opción Clave de API obligatoria está establecida en false y no realiza los pasos anteriores, las claves de API asociadas a una etapa de API no se usarán con el método.
Crear una clave de API
Si ya ha creado o importado claves de API para utilizarlas con planes de uso, puede omitir este procedimiento y el siguiente.
Para crear una clave de API
Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway
. Elija una API de REST.
-
En el panel de navegación principal de API Gateway, elija Claves de API.
-
Elija Crear clave de la API.
-
En Nombre, ingrese un nombre.
(Opcional) En Description (Descripción), introduzca una descripción.
-
En Clave de API, elija Generar automáticamente para que API Gateway genere el valor de la clave o elija Personalizar para crear su propio valor de la clave.
-
Seleccione Guardar.
Importar claves de API
El siguiente procedimiento describe cómo importar claves de API para usarlas con planes de uso.
Para importar claves de API
Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway
. Elija una API de REST.
-
En el panel de navegación principal, elija Claves de API.
-
Elija el menú desplegable Acciones y, a continuación, elija Importar claves de API.
-
Para cargar un archivo de claves separado por comas, elija Elegir archivo. También puede ingresar las claves en el editor de texto. Para obtener información sobre el formato de los archivos, consulte Formato de archivo de clave de API de API Gateway.
-
Elija Error en advertencias para que la importación se detenga cuando se produzca un error o elija Omitir advertencias para que se sigan importando las entradas de clave válidas cuando se produzca una advertencia.
-
Elija Importar para importar las claves de API.
