Usa claves de API

En esta página, se describe cómo utilizar las claves de API en API Gateway.

Una clave de API es una string simple que identifica un proyecto de Google Cloud para fines de cuotas, facturación y supervisión. Un desarrollador genera una clave de API en un proyecto en la consola de Google Cloud y, luego, incorpora esa clave en cada llamada a tu API como un parámetro de consulta o en un encabezado de solicitud.

Si especificas un requisito de clave de API en la configuración de tu API, API Gateway usa la clave de API para buscar el proyecto de Google Cloud asociado. En API Gateway, se rechazan las solicitudes, a menos que la clave de API se haya generado en tu proyecto de Google Cloud o en otros proyectos de la plataforma en los que está habilitada la API.

Nota: A diferencia de las credenciales que usan tokens de corta duración o solicitudes firmadas, las claves de API funcionan como parte de la solicitud a la API. Como resultado, las claves de API son vulnerables a los ataques de intermediarios y es posible que no sean tan seguras como otras credenciales de autenticación. Puedes usar claves de API además de una de las otras formas de autenticación admitidas, pero no te recomendamos que uses solo claves de API cuando las llamadas a la API contengan datos sensibles.

Para crear una clave de API o ver las claves de API que ya están disponibles en tu proyecto de Google Cloud, ve a la página APIs y servicios > Credenciales.

Ir a Credenciales

Caso de uso

Para usar las funciones de API Gateway, como las quotas, puedes pasar una clave de API a fin de que API Gateway pueda identificar el proyecto de Google Cloud con el que está asociada la aplicación cliente.

Información sobre la autenticación de clave de API para API Gateway

Si utilizas una clave de API para la autenticación, primero debes habilitar la compatibilidad con la clave de API para tu servicio.

Ingresa el siguiente comando:

gcloud services enable MANAGED_SERVICE_NAME

MANAGED_SERVICE_NAME especifica el nombre del servicio administrado que se creó cuando implementaste la API. Puedes encontrar este nombre en la columna Servicio administrado de tu API en la página de destino de las APIs en la consola. Como alternativa, puedes encontrar este nombre en la propiedad Managed service cuando usas el comando gcloud api-gateway apis describe.

Por ejemplo:

gcloud services enable my-api-a12bcd345e67f89g0h.apigateway.my-project.cloud.goog

Cómo restringir las claves de API

Las claves de API no están restringidas de forma predeterminada. Las claves no restringidas son inseguras porque cualquier persona puede usarlas desde cualquier lugar. Te recomendamos que agregues restricciones de API siempre que sea posible. Las restricciones de API especifican a qué API se puede llamar mediante la clave de API. Todas las claves de API que usan las aplicaciones de producción deben tener restricciones de API.

Para agregar restricciones de API, sigue estos pasos:

1. Busca el título de la API como se indica en tu configuración de API. En el siguiente ejemplo, el título de la API es My Example Config:

   # openapi.yaml
   swagger: '2.0'
   info:
     title: My Example Config
     description: Sample API on API Gateway
     version: 1.0.0
   ...
   

2. En la consola de Google Cloud, ve a la página API y servicios > Credenciales.

   Ir a Credenciales

3. Selecciona el nombre de la clave de API que deseas usar para tu API.

4. En la sección Restricciones de API de la página de detalles de la clave de API, haz clic en Restringir clave.

5. En la lista desplegable de APIs disponibles, selecciona la API a la que se usará tu clave de API. Por ejemplo, si usas la configuración de ejemplo anterior, selecciona My Example Config.

6. Haz clic en Guardar.

La restricción debería aplicarse en un momento.