Cuando la aplicación solicite datos privados, la solicitud debe recibir la autorización de un usuario autenticado que tenga acceso a esos datos.
Cuando tu aplicación solicite datos públicos, no es necesario que la solicitud esté autorizada, pero sí que vaya acompañada de un identificador, como una clave de API.
Todas las solicitudes que envíe tu aplicación a la API Resource Manager deben identificar tu aplicación ante Google. Hay dos formas de identificar tu aplicación: mediante un token de OAuth 2.0 (que también autoriza la solicitud) o mediante la clave de API de la aplicación. Para determinar cuál de esas opciones debes usar, sigue estos pasos:
- Si la solicitud requiere autorización (por ejemplo, una solicitud de datos privados de un usuario), la aplicación debe proporcionar un token de OAuth 2.0 con la solicitud. La aplicación también puede proporcionar la clave de API, pero no es obligatorio.
- Si la solicitud no requiere autorización (como una solicitud de datos públicos), la aplicación debe proporcionar la clave de API o un token de OAuth 2.0, o ambos, según lo que te resulte más cómodo.
Información sobre los protocolos de autorización
La aplicación debe utilizar OAuth 2.0 para autorizar las peticiones. No se admite ningún otro protocolo de autorización. Si tu aplicación usa la función Iniciar sesión con Google, algunos aspectos de la autorización se gestionan automáticamente.
Autorizar peticiones con OAuth 2.0
Las solicitudes a la API Resource Manager de datos de usuario no públicos deben estar autorizadas por un usuario autenticado.
Los detalles del proceso de autorización (o "flujo") de OAuth 2.0 varían un poco en función del tipo de aplicación que estés escribiendo. El proceso general que se presenta a continuación se aplica a todos los tipos de aplicación:
- Cuando crees tu aplicación, debes registrarla con la consolaGoogle Cloud . A continuación, desde Google proporcionamos información que necesitarás más tarde, como un ID de cliente y un secreto de cliente.
- Activa la API Resource Manager en la Google Cloud consola. Si la API no aparece en la Google Cloud consola, sáltate este paso.
- Cuando la aplicación necesita acceder a datos de usuario, solicita a Google un ámbito concreto de acceso.
- Google muestra una pantalla de autorización al usuario con al que le pide autorización para que la aplicación solicite algunos datos.
- Si el usuario da su aprobación, en Google se le concede a la aplicación un token de acceso de duración breve.
- Tu aplicación solicita datos de usuario. Para solicitarlos, adjunta el token de acceso a la solicitud.
- Si en Google se determina que la petición y el token son válidos, se devuelven los datos solicitados.
En algunos flujos se incluyen más pasos, como el uso de tokens de actualización para adquirir nuevos tokens de acceso. Para obtener información detallada sobre los flujos de los distintos tipos de aplicaciones, consulta la documentación de OAuth 2.0 de Google.
A continuación, te indicamos información sobre los permisos de OAuth 2.0 en la API Resource Manager:
| Ámbito | Significado |
|---|---|
https://www.googleapis.com/auth/cloud-platform |
Acceso de lectura y escritura. |
Si deseas solicitar acceso mediante OAuth 2.0, la aplicación necesita la información del permiso, así como la información que proporciona Google durante el registro de la aplicación (como el ID y el secreto de cliente).
Consejo: Las bibliotecas cliente de Google APIs pueden administrar algunos de los procesos de autorización de forma automática. Se pueden usar con varios lenguajes de programación; consulta más información en la página con bibliotecas y ejemplos.
Obtener y usar una clave de API
Las solicitudes a la API Resource Manager para obtener datos públicos deben ir acompañadas de un identificador, que puede ser una clave de API o un token de acceso.
Para obtener una clave de API, sigue estos pasos:
- Abre la página Credenciales en la consola de Google Cloud .
-
Esta API admite dos tipos de credenciales.
Crea las credenciales que sean adecuadas para tu proyecto:
-
OAuth 2.0: cada vez que tu aplicación solicite datos de usuario privados, debe enviar un token de OAuth 2.0 junto con la solicitud. Tu aplicación envía primero un ID de cliente y, posiblemente, un secreto de cliente para obtener un token. Puedes generar credenciales de 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: Una solicitud que no proporcione un token de OAuth 2.0 debe enviar una clave de API. La clave identifica tu proyecto y proporciona acceso a la API, cuota e informes.
La API admite varios tipos de restricciones en las claves de API. Si la clave de API que necesitas aún no existe, créala en la consola haciendo clic en Crear credenciales > Clave de API. Puedes restringir la clave antes de usarla en producción haciendo clic en Restringir clave y seleccionando una de las restricciones.
-
Para mantener tus claves de API protegidas, sigue las prácticas recomendadas para usar claves de API de forma segura.
Una vez que tengas una clave de API, tu aplicación podrá añadir el parámetro de consulta key=yourAPIKey a todas las URLs de solicitud.
La clave de API se puede insertar en URLs de forma segura, por lo que no necesita ninguna codificación.