Cuando con tu aplicación se solicitan datos privados, la solicitud debe estar autorizada por un usuario autenticado que tenga acceso a esos datos.
Si mediante tu aplicación se solicitan datos públicos, no es necesario autorizar la solicitud, ni que vaya acompañada de un identificador, como una clave de API.
Es necesario que, en cada solicitud que se envía con tu aplicación a la API de Resource Manager, se identifique tu aplicación en Google. Hay dos formas de identificar tu aplicación: mediante un token OAuth 2.0 (con el que también se autoriza la solicitud) o mediante la clave de API de la aplicación. La siguiente es una explicación de cómo determinar cuáles de esas opciones puedes usar:
- Si se requiere autorización para la solicitud (como una solicitud de datos privados de un individuo), se debe utilizar la aplicación a fin de proporcionar un token OAuth 2.0 con la solicitud. Con la aplicación, también se puede proporcionar la clave de API, pero no es necesario.
- Si no se requiere autorización para la solicitud (como una solicitud de datos públicos), se debe utilizar la aplicación a fin de proporcionar la clave de API o un token de OAuth 2.0, o ambas opciones.
Acerca de los protocolos de autorización
Tu aplicación debe usar OAuth 2.0 para autorizar solicitudes. Otros protocolos de autorización no son compatibles. Si tu aplicación usa Acceder con Google, tú controlarás algunos aspectos de la autorización.
Autoriza solicitudes con OAuth 2.0
Las solicitudes a la API de Resource Manager para datos de usuarios no públicos deben contar con la autorización de un usuario autenticado.
Los detalles del proceso de autorización, o “flujo”, para OAuth 2.0 varían de alguna manera según el tipo de aplicación que se escribe. El siguiente proceso general se aplica a todos los tipos de aplicación:
- Cuando creas tu aplicación, la registras con la consola de Google Cloud. Luego, en Google se proporciona la información que necesitarás más tarde, como el ID y un secreto del cliente.
- Activa la API de Resource Manager en la consola de Google Cloud. (Si la API no aparece enumerada en la consola de Google Cloud, omite este paso).
- Cuando la aplicación necesite acceder a datos del usuario, solicita a Google un alcance de acceso en particular.
- Google le mostrará una pantalla de consentimiento al usuario, en la que le pedirá que permita a la aplicación solicitar algunos de sus datos.
- Si el usuario la aprueba, Google le otorgará a la aplicación un token de acceso de corta duración.
- La aplicación solicitará los datos del usuario y adjuntará el token de acceso a la solicitud.
- Si Google determina que la solicitud y el token son válidos, mostrará los datos solicitados.
Algunos flujos incluyen pasos adicionales, como el uso de tokens de actualización, para adquirir nuevos tokens de acceso. Si deseas obtener información detallada sobre los flujos para varios tipos de aplicaciones, consulta la documentación de OAuth 2.0 de Google.
La siguiente es la información del alcance en OAuth 2.0 para la API de Resource Manager:
Alcance | Significado |
---|---|
https://www.googleapis.com/auth/cloud-platform |
Acceso de lectura/escritura |
Para solicitar acceso con OAuth 2.0, tu aplicación necesita información sobre el alcance, además de la información que Google proporciona cuando registras la aplicación (como el ID y el secreto del cliente).
Sugerencia: Con las bibliotecas cliente de las API de Google, se pueden controlar algunos de los procesos de autorización sin tu intervención. Estas están disponibles para una variedad de lenguajes de programación. Si deseas obtener más información, consulta la página que incluye bibliotecas y ejemplos.
Adquiere y usa una clave de API
Las solicitudes a la API de Resource Manager para datos públicos deben ir acompañadas de un identificador, que puede ser una clave de API o un token de acceso.
Para adquirir una clave de API, haz lo siguiente:
- Abre la página Credenciales en la consola de Google Cloud.
-
En esta API, se admiten dos tipos de credenciales.
Crea las credenciales apropiadas para tu proyecto:
-
OAuth 2.0: Siempre que se soliciten datos privados del usuario, mediante tu aplicación se debe enviar un token OAuth 2.0 junto con la solicitud. En primer lugar, se envía un ID de cliente y, posiblemente, un secreto de cliente para obtener un token a través de la aplicación. Puedes generar credenciales OAuth 2.0 para aplicaciones web, cuentas de servicio o aplicaciones instaladas.
Para obtener más información, consulta la documentación de OAuth 2.0.
-
Claves de API: Si mediante una solicitud no se proporciona un token de OAuth 2.0, entonces se debe enviar una clave de API. Con la clave de API, se identifica tu proyecto y se proporciona acceso a la API, la cuota y los informes.
En la API, se admiten varios tipos de restricciones sobre las claves de API. Si la clave de API que necesitas aún no existe, crea una clave de API en Console; para ello, haz clic en Crear credenciales > Clave de API. Puedes restringir la clave antes de usarla en producción si haces clic en Restringir clave y seleccionas una de las Restricciones.
-
Para garantizar la seguridad de tus claves de API, sigue las prácticas recomendadas de uso seguro de las claves de API.
Una vez que tienes una clave de API, puedes usar tu aplicación para adjuntar el parámetro de consulta key=yourAPIKey
a todas las URL de solicitud.
La clave de API en las URL se incorpora de manera segura, por lo que no necesita codificación.