Usa claves de API con la API de Roads

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Los productos de Google Maps Platform se protegen del uso no autorizado mediante la restricción de las llamadas a la API a aquellas que proporcionan las credenciales de autenticación adecuadas. Estas credenciales tienen la forma de una clave de API, es decir, una string alfanumérica única que asocia tu cuenta de facturación de Google con tu proyecto y con la API o el SDK específicos.

En esta guía, se muestra cómo crear, restringir y usar tu clave de API para Google Maps Platform.

Antes de comenzar

Antes de comenzar a usar la API de Roads, necesitas un proyecto con una cuenta de facturación y la API de Roads habilitada. Si deseas obtener más información, consulta Set up in Cloud Console.

Cómo crear claves de API

La clave de API es un identificador único que se utiliza para autenticar solicitudes asociadas a tu proyecto con fines de uso y facturación. Debes tener, al menos, una clave de API asociada a tu proyecto.

Para crear una clave de API, sigue estos pasos:

Console

  1. Ve a la página Google Maps Platform > Credenciales.

    Ir a la página Credenciales

  2. En la página Credenciales, haz clic en Crear credenciales > Clave de API.
    El diálogo Se creó la clave de API mostrará la clave de API que acabas de crear.
  3. Haz clic en Cerrar.
    La nueva clave de API aparecerá en la página Credenciales debajo de Claves de API.
    (Recuerda restringir la clave de API antes de utilizarla en producción).

SDK de Cloud

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

Obtén más información sobre el SDK de Google Cloud, la instalación del SDK de Cloud y los siguientes comandos:

Cómo restringir las claves de API

Google recomienda que restrinjas las claves de API limitando su uso solo a aquellas APIs que sean necesarias para tu aplicación. La restricción de las claves de API agrega seguridad a tu aplicación, ya que la protege de solicitudes no autorizadas. Para obtener más información, consulta Prácticas recomendadas sobre la seguridad de la API.

Para restringir una clave de API, sigue estos pasos:

Console

  1. Ve a la página Google Maps Platform > Credenciales.

    Ir a la página Credenciales

  2. Selecciona la clave de API para la que deseas establecer una restricción. Aparecerá la página de propiedades de la clave de API.
  3. En Restricciones de clave, establece las siguientes restricciones:
    • Restricciones de aplicaciones:
      1. Para aceptar solicitudes de la lista de direcciones IP de servidor web que proporcionas, selecciona Direcciones IP (servidores web, trabajos cron, etc.) en la lista de Restricciones de aplicaciones. Especifica una dirección IPv4 o IPv6 o una subred con notación CIDR (p.ej., 192.168.0.0/22). Debido a que una solicitud de servicio web de servicio web verifica y compara la dirección IP externa con la restricción de la clave de API, usa la dirección IP pública del servidor.
    • Restricciones de API:
      1. Haz clic en Restringir clave.
      2. Selecciona API de Roads en el menú desplegable Select APIs. Si la API de Roads no aparece en la lista, debes habilitarla.
  4. Para finalizar los cambios, haz clic en Guardar.

SDK de Cloud

Enumera las claves existentes.

gcloud services api-keys list --project="PROJECT"

Borra las restricciones que existen sobre la clave existente.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

Establece restricciones nuevas sobre la clave existente.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api_target="roads.googleapis.com"
    --allowed-ips="IP_ADDRESS"

Obtén más información sobre el SDK de Google Cloud, la instalación del SDK de Cloud y los siguientes comandos:

Cómo agregar la clave de API a tu solicitud

Debes incluir una clave de API con cada solicitud a la API de Roads. En el siguiente ejemplo, reemplaza YOUR_API_KEY por tu clave de API.

https://roads.googleapis.com/v1/snapToRoads?path=-35.27801,149.12958|-35.28032,149.12907|-35.28099,149.12929|-35.28144,149.12984|-35.28194,149.13003|-35.28282,149.12956|-35.28302,149.12881|-35.28473,149.12836 &interpolate=true &key=YOUR_API_KEY

Se requiere HTTPS para las solicitudes que usan una clave de API.