Utilizar 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 cadena sencilla que identifica un Google Cloud proyecto con fines de cuota, facturación y monitorización. Un desarrollador genera una clave de API en un proyecto de la Google Cloud consola e inserta esa clave en cada llamada a tu API como 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 usará la clave de API para buscar el proyecto Google Cloud asociado. API Gateway rechaza las solicitudes a menos que la clave de API se haya generado en tu proyecto Google Cloud o en otros proyectosGoogle Cloud en los que se haya habilitado tu API.

Nota: A diferencia de las credenciales que usan tokens de corta duración o solicitudes firmadas, las claves de API forman parte de la solicitud de API. Por lo tanto, las claves de API son vulnerables a los ataques de intermediario y puede 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 que ya están disponibles en tu proyecto de Google Cloud , ve a la página APIs y servicios > Credenciales.

Ir a Credenciales

Caso práctico

Para usar las funciones de API Gateway, como las cuotas, puedes incluir una clave de API para que API Gateway pueda identificar el Google Cloud proyecto al que está asociada la aplicación cliente.

Información sobre la autenticación con claves de API en API Gateway

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

Introduce el siguiente comando:

gcloud services enable MANAGED_SERVICE_NAME

El MANAGED_SERVICE_NAME especifica el nombre del servicio gestionado que se creó al implementar la API. Puedes encontrar este nombre en la columna Servicio gestionado de tu API en la página de destino de APIs de la consola. También puede encontrar este nombre en la propiedad Managed service cuando use el comando gcloud api-gateway apis describe.

Por ejemplo:

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

Restringir claves de API

Las claves de API no tienen restricciones de forma predeterminada. Las claves sin restricciones no son seguras porque cualquier persona puede usarlas desde cualquier lugar. Te recomendamos que añadas restricciones de API siempre que sea posible. Las restricciones de API especifican a qué APIs se puede llamar con la clave de API. Todas las claves de API que usen las aplicaciones de producción deben tener restricciones de API.

Para añadir restricciones de API, sigue estos pasos:

1. Busca el título de la API, tal como se indica en la configuración de la 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 APIs y servicios > Credenciales.

   Ir a Credenciales

3. Selecciona el nombre de la clave de API que quieras usar en 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 accederá con tu clave de API. Por ejemplo, si usa la configuración de ejemplo anterior, seleccione My Example Config.

6. Haz clic en Guardar.

La restricción debería aplicarse en breve.