Descripción general de las claves de API

Una clave de API es una cadena encriptada simple que puedes usar cuando llamas a las APIs deGoogle Cloud . Un uso típico de una clave de API es pasarla a una llamada a la API de REST como un parámetro de consulta con el siguiente formato:

http://example-library.googleapis.com/v1/publishers/mypublisher/books?key=API_KEY
Las claves de API son útiles para acceder a datos públicos de forma anónima y se usan para asociar las solicitudes a la API con el proyecto del consumidor Google Cloud para las cuotas y la facturación.

Las claves de API te proporcionan una interfaz programática para crear y administrar claves de API para tu proyecto. Te brinda más control sobre las claves de API que las tareas relacionadas con las claves de API que puedes realizar en la consola de Google Cloud .

Para obtener más información sobre la autenticación en las APIs de Google Cloud y determinar la mejor estrategia de autenticación para situaciones comunes, consulta la Descripción general de la autenticación. Si deseas obtener más información sobre el uso de claves de API para las APIs y los SDKs de Google Maps Platform, consulta la documentación de Google Maps Platform.

Protege una clave de API

Cuando uses claves de API en tus aplicaciones, asegúrate de que se mantengan seguras durante el almacenamiento y la transmisión. Si expones tus credenciales de forma pública, puedes poner en riesgo tu cuenta y generar cargos inesperados en ella. Para ayudarte a mantener tus claves de API seguras, sigue estas prácticas recomendadas:

  • No incorpores claves de API directamente en el código. Las claves de API incorporadas en el código pueden exponerse de forma accidental al público. Por ejemplo, podrías olvidarte de quitar las claves cuando compartes el código. En lugar de incorporar tus claves de API en tus aplicaciones, almacénalas en variables de entorno o en archivos fuera del árbol de origen de tu aplicación.

  • Agrega restricciones a la clave de API. Si agregas restricciones, puedes reducir el impacto de una clave de API vulnerada.

  • Borra las claves de API innecesarias para minimizar la exposición a los ataques.

  • Rota tus claves de API de forma periódica. Para rotar tus claves de API, llama al método CreateKey. Después de crear las claves de reemplazo, actualiza tus aplicaciones para que usen las claves recién generadas y borra las claves anteriores.

  • Revisa tu código antes de lanzarlo de forma pública. Asegúrate de que tu código no contenga claves de API o cualquier otra información privada antes de hacer que tu código esté disponible de forma pública.

¿Qué sigue?