Configuración de claves API para API de REST en API Gateway - Amazon API Gateway
Exigir una clave de API en un métodoCrear una clave de APIImportar claves de API

Configuración de claves API para API de REST en 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 Configuración de planes de uso para API de REST en 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.

AWS Management Console
Para configurar un método de API para exigir una clave de API

  1. Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway.

  2. Elija una API de REST.

  3. En el panel de navegación principal de API Gateway, elija Resources (Recursos).

  4. En Resources (Recursos), cree un método nuevo o elija uno existente.

  5. En la pestaña Solicitud de método, en Configuración de solicitud de método, elija Editar.

    Agregación de una clave de API a un método

  6. Seleccione Clave de API obligatoria.

  7. Seleccione Save.

  8. 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.

AWS CLI

El siguiente comando put-method crea un método PUT que requiere una clave de API:

aws apigateway put-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method PUT \
    --authorization-type "NONE" \
    --api-key-required

El siguiente comando update-method actualiza un método existente para que requiera una clave de API:

aws apigateway update-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method PUT \
    --patch-operations op="replace",path="/apiKeyRequired",value="true"
REST API

Para exigir una clave de API en un método, realice alguna de las siguientes operaciones:

  • Llame a method:put para crear un método. Establezca apiKeyRequired en true en la carga de la solicitud.

  • Llame a method:update para establecer apiKeyRequired en true.

Crear una clave de API

El procedimiento siguiente muestra cómo crear una clave de API. Si desea importar la clave de API, omita este paso.

AWS Management Console
Para crear una clave de API

  1. Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway.

  2. Elija una API de REST.

  3. En el panel de navegación principal de API Gateway, elija Claves de API.

  4. Elija Crear clave de la API.

    Crear claves de API para planes de uso

  5. En Nombre, ingrese un nombre.

  6. (Opcional) En Description (Descripción), introduzca una descripción.

  7. 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.

  8. Seleccione Save.

AWS CLI

El siguiente comando create-api-key crea una clave de API:

 aws apigateway create-api-key \
    --name 'Dev API key' \
    --description 'API key for Devs' \
    --enabled
REST API

Llame a apikey:create para crear una clave de API.

Importar claves de API

En el procedimiento siguiente se describe cómo importar claves de API. Si ya ha creado una clave de API, omita este paso.

AWS Management Console
Para importar claves de API

  1. Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway.

  2. Elija una API de REST.

  3. En el panel de navegación principal, elija Claves de API.

  4. Elija el menú desplegable Acciones y, a continuación, elija Importar claves de API.

  5. 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.

  6. 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.

  7. Elija Importar para importar las claves de API.

AWS CLI

El siguiente comando import-api-keys importa una clave de API:

aws apigateway import-api-key \
    a--body fileb://keys.csv \
    --format csv
REST API

Llame a apikey:import para importar una clave de API desde un archivo. Para el formato de archivo, consulte Formato de archivo de clave de API de API Gateway.

No se puede cambiar el valor de la nueva clave de API. Después de crear la API, configure un plan de uso. Para obtener más información, consulte Configuración de planes de uso para API de REST en API Gateway.