Usar OAuth

La API de Aerial View admite el uso de OAuth 2.0 para la autenticación. Google admite situaciones comunes de OAuth 2.0, como las de un servidor web.

En este documento, se describe cómo pasar un token de OAuth a la llamada a la API de Aerial View en tu entorno de desarrollo. Si quieres obtener instrucciones para usar OAuth en un entorno de producción, consulta Autenticación en Google.

Antes de comenzar

Antes de comenzar a usar la API de Aerial View, debes tener un proyecto con una cuenta de facturación y la API de Aerial View habilitada. Recomendamos crear varios propietarios de proyecto y administradores de facturación a fin de que tu equipo siempre tenga a alguien disponible con estos roles. Si deseas obtener más información, consulta Set up in Cloud Console.

Acerca de OAuth

Existen muchas formas de crear y administrar tokens de acceso con OAuth basados en tu entorno de implementación.

Por ejemplo, el sistema Google OAuth 2.0 admite interacciones servidor a servidor, como las que se producen entre tu aplicación y un servicio de Google. Para esta situación, necesitas una cuenta de servicio, que es una cuenta que pertenece a tu aplicación en lugar de a un usuario final individual. Tu aplicación llama a las APIs de Google en nombre de la cuenta de servicio, por lo que los usuarios no están involucrados de forma directa. Si deseas obtener más información sobre los métodos de autenticación, consulta Autenticación en Google.

De manera alternativa, puedes usar la API de Aerial View como parte de una app para dispositivos móviles de Android o iOS. Si deseas obtener información general sobre el uso de OAuth con la API de Aerial View, incluida la información sobre cómo administrar tokens de acceso para diferentes entornos de implementación, consulta Usa OAuth 2.0 para acceder a las APIs de Google.

Acerca de los permisos de OAuth

Para utilizar OAuth con la API de Aerial View, se debe asignar el alcance al token de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Ejemplo: Prueba las llamadas a la API de REST en tu entorno de desarrollo local

Si quieres probar la API de Aerial View con un token de OAuth, pero no tienes un entorno configurado para generar tokens, puedes usar el procedimiento de esta sección para realizar la llamada.

En este ejemplo, se describe cómo usar el token de OAuth que proporcionan las credenciales predeterminadas de la aplicación (ADC) para realizar la llamada. Si quieres obtener información sobre el uso de ADC para llamar a las APIs de Google con bibliotecas cliente, consulta Autenticación con bibliotecas cliente.

Requisitos previos

Antes de realizar una solicitud de REST con ADC, usa Google Cloud CLI para proporcionar credenciales al ADC:

  1. Si aún no lo hiciste, crea un proyecto y habilita la facturación siguiendo los pasos en Configuración en la consola de Google Cloud.
  2. Instala e inicializa gcloud CLI
  3. Ejecuta el siguiente comando gcloud en tu máquina local para crear el archivo de credenciales:

    gcloud auth application-default login
  4. Se muestra una pantalla de acceso. Después de acceder, tus credenciales se almacenan en el archivo de credenciales local que usa el ADC.

Para obtener más información, consulta la sección Entorno de desarrollo local de la documentación Proporciona credenciales para las credenciales predeterminadas de la aplicación.

Realiza una solicitud de REST

En este ejemplo, se pasan dos encabezados de solicitud:

  • Pasa el token de OAuth en el encabezado Authorization con el siguiente comando para generarlo:

    gcloud auth application-default print-access-token

    El token que se muestra tiene un alcance de https://www.googleapis.com/auth/cloud-platform..

  • Pasa el ID o el nombre del proyecto de Google Cloud que tenga habilitada la facturación en el encabezado X-Goog-User-Project. Si deseas obtener más información, consulta el artículo Configuración en la consola de Cloud.

En el siguiente ejemplo, se hace una llamada a la API de Aerial View usando un token de OAuth:

curl -X GET \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H "Authorization: Bearer $TOKEN" \
"https://aerialview.googleapis.com/v1/videos:lookupVideo?&address=1600%20Amphitheatre%20Pkwy%2C%20Mountain%20View%2C%20CA%2094043"

Solución de problemas

Si tu solicitud muestra un mensaje de error que indica que las credenciales de usuario final no son compatibles con esta API, consulta Las credenciales de usuario no funcionan.