Todas las aplicaciones de Google Maps Directions API requieren autenticación.
- Usuarios de la API estándar: si usas la API con el plan estándar, debes emplear una clave de API configurada en el proyecto que elijas. Consulta más información sobre las claves de API para la API estándar.
Incluir una clave en tu solicitud te permite controlar el uso de la API por parte de tu aplicación en Google API Console, habilita el acceso a una [cuota diaria gratuita] generosa y garantiza que Google pueda comunicarse contigo respecto de tu aplicación, si es necesario.
- Usuarios de la Premium Plan: si usas la API con el Google Maps APIs Premium Plan, existen dos métodos de autenticación.
- Usa una clave de API configurada en el proyecto de Google Maps APIs Premium Plan (creada cuando compraste Premium Plan).
- Incluye un ID de cliente y una firma digital en lugar de una clave de API.
Consulta la sección de Google Maps APIs Premium Plan, a continuación, para obtener información sobre cómo elegir el mejor método de autenticación.
- Usa una clave de API configurada en el proyecto de Google Maps APIs Premium Plan (creada cuando compraste Premium Plan).
Autenticación para la API estándar: claves de API
Obtén una clave de API
Para comenzar a usar Google Maps Directions API, haz clic en el botón que aparece a continuación y que activa Google Maps Directions API automáticamente.
Obtener una claveTambién puedes seguir estos pasos para obtener una clave de API:
- Ingresa a Google API Console.
- Crea o selecciona un proyecto.
- Haz clic en Continue para habilitar la API.
- En la página Credentials, obtén una clave de API (y configura las restricciones para esta).
Nota: Si ya tienes una clave de API sin restricciones, o una clave con restricciones de servidor, debes usar esa clave. - Para evitar el robo de cuota, protege tu clave de API siguiendo estas prácticas recomendadas.
- (Opcional) Habilita la facturación. Para obtener más información, consulta Límites de uso.
También puedes buscar una clave existente en Google API Console.
Para obtener más información sobre el uso de la Google API Console, consulta Ayuda de la API Console.
Tipos de restricciones de clave de API
Las Google Maps API están disponibles para apps de Android o iOS y navegadores web, y a través de servicios web HTTP. Las API de cualquier plataforma pueden usar una clave de API genérica (sin restricciones). También puedes agregar una restricción (por ejemplo, una dirección IP) a la clave de API. Una vez restringida, la clave solo funcionará en plataformas que admitan ese tipo de restricción. Obtén más información sobre claves y credenciales.
Especifica una clave en tu solicitud
Para especificar una clave en tu solicitud, inclúyela como el valor de un parámetro key.
Por ejemplo:
https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&key=YOUR_API_KEY Autenticación para clientes de Google Maps APIs Premium Plan
La información de esta sección corresponde solamente al nuevo Google Maps APIs Premium Plan, que se encuentra disponible desde el 6 de enero de 2016.
¿Tienes una licencia anterior de Maps APIs for Work o de Maps API for Business? Consulta nuestra guía sobre licencias de Maps APIs for Work. Para determinar si tienes una licencia anterior: en el Google Cloud Support Portal, haz clic en Maps: Usage Report a la izquierda. Si el ID de la parte superior del informe se encuentra en el siguiente formato, contarás con el nuevo Premium Plan: gme-[empresa] & proj-[número] ([tipo])
. De lo contrario, tu licencia será más antigua.
Cuando uses Google Maps Directions API con una licencia del Google Maps APIs Premium Plan, debes autenticar tu aplicación con una clave de API o tu ID de cliente. A su vez, las solicitudes con ID de cliente también requieren una firma digital. Nota: Si ya cuentas con una licencia anterior de Maps API for Business, debes usar un ID de cliente y no una clave de API.
Cuando debas decidir el método de autenticación, ten en cuenta lo siguiente:
- La clave de API (disponible para clientes de Google Maps APIs Premium Plan, pero no para quienes ya tengan una licencia de Maps API for Business). Si usas una clave de API para autenticar solicitudes, puedes hacer lo siguiente:
- gestionar todas tus API en la Google API Console;
- acceder a datos de uso en tiempo real y datos de uso históricos (30 días) de tu aplicación en la Google API Console;
- ver informes de uso con más de 30 días de datos en el Google Cloud Support Portal.
- El ID de cliente. Si usas tu ID de cliente (en lugar de la clave de API) para autenticar solicitudes, puedes hacer lo siguiente:
- agregar el parámetro
channela las solicitudes para poder ver informes de uso más completos; - ver informes de uso con más de 30 días de datos en el Google Cloud Support Portal.
- usar herramientas de Maps Analytics para Maps JavaScript API.
- agregar el parámetro
Obtén más información sobre los informes disponibles para clientes de Premium Plan.
Usar una clave de API
Para autenticar la Directions API con una clave de API, haz clic en el botón que aparece a continuación. Este te permitirá acceder a la Google API Console y te guiará en el proceso.
Importante: En el menú desplegable del proyecto, asegúrate de seleccionar el proyecto que se creó cuando adquiriste el Premium Plan. El nombre del proyecto comienza con Google Maps APIs for Business or Google Maps for Work or Google Maps.
Obtener una claveTambién puedes seguir estos pasos para obtener una clave de API:
- Ingresa a Google API Console.
- En el menú desplegable Project, selecciona el proyecto Google Maps Premium.*
- Haz clic en Continue.
- En la página Credentials, obtén una clave de API (y configura las restricciones para esta).
Nota: Si ya tienes una clave de API sin restricciones, o una clave con restricciones de servidor, debes usar esa clave. - Para evitar el robo de cuota, protege tu clave de API siguiendo estas prácticas recomendadas.
* Nota: En el menú desplegable de proyectos, debes seleccionar el proyecto que se creó para ti cuando compraste Premium Plan. El nombre del proyecto comienza con Google Maps APIs for Business or Google Maps for Work or Google Maps. Importante: Si ya cuentas con una licencia anterior de Maps API for Business, debes usar un ID de cliente y no una clave de API.
También puedes buscar una clave existente en Google API Console.
Para obtener más información sobre el uso de la Google API Console, consulta Ayuda de la API Console.
Especifica una clave en tu solicitud
Para especificar una clave en tu solicitud, inclúyela como el valor de un parámetro key.
Por ejemplo:
https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&key=YOUR_API_KEY Usar un ID de cliente
Para autenticar la Directions API con un ID de cliente (en lugar de una clave de API), se necesitan dos parámetros de autenticación: el ID de cliente y la firma digital exclusiva.
Si antes usabas una clave de API para la autenticación, pero ahora deseas usar un ID de cliente, debes quitar el parámetro key de las solicitudes. Los servicios web de Google Maps API rechazarán solicitudes con ID de cliente y clave de API.
Tu ID de cliente y firma
Cuando adquieras tu licencia de Google Maps APIs Premium Plan, Google te enviará un correo electrónico de bienvenida con tu ID de cliente y tu clave criptográfica privada.
-
El ID de cliente se usa para poder acceder a las funciones especiales de Google Maps APIs Premium Plan. Todos los ID de cliente comienzan con un prefijo gme-. Pasa tu ID de cliente como valor del parámetro
client. -
Con tu clave criptográfica privada, se genera una firma digital exclusiva. Pasa esta firma como valor del parámetro
signature. A continuación, en la sección de firmas digitales, encontrarás información adicional sobre la generación de firmas.
https://maps.googleapis.com/maps/api/directions/json
?origin=Toronto
&destination=Montreal
&client=gme-YOUR_CLIENT_ID
&signature=YOUR_URL_SIGNATURE Si extraviaste tu ID de cliente o clave criptográfica privada, podrás recuperarlos iniciando sesión en Google Cloud Support Portal y haciendo clic en Maps: Manage Client ID, en los vínculos a la izquierda de la página.
Parámetro opcional para los informes
Cuando uses el ID de cliente para autenticar la API, también contarás con el siguiente parámetro opcional:
channelse usa para que tus informes sean más detallados, ya que permite agrupar en ellos diferentes canales por separado. Consulta Descripción general sobre informes del plan premium para obtener más información.
Firmas digitales
Para las solicitudes a Directions API por parte de clientes de Google Maps APIs Premium Plan, se requiere una firma digital signature, la cual se genera con la clave criptográfica privada que te proporcionamos en tu correo electrónico de bienvenida.
El proceso de inicio de sesión usa un algoritmo de encriptación que combina una URL y una clave. La firma exclusiva obtenida permite a nuestros servidores verificar que los sitios que generen solicitudes con tu ID de cliente estén autorizados para hacerlo. La firma también es exclusiva de cada URL. De esta forma, se garantiza que las solicitudes que usen tu ID de cliente no se puedan modificar sin generar una nueva firma.
Tu clave criptográfica privada
Tu clave criptográfica privada para firmas de URL se generará con tu ID de cliente y es una “clave secreta compartida” entre tú y Google. Esta clave para firmas es solo tuya y es exclusiva de tu ID de cliente. Por esta razón, debes asegurarte de que tu clave para firmas esté protegida. Esta clave no debe pasarse en ninguna solicitud, almacenarse en sitios web ni publicarse en foros públicos. Si alguien obtiene esta clave de firma, podrá realizar solicitudes falsas con tu identidad.
Nota: Esta clave criptográfica privada para firmas no es igual a las claves de API que emite la Google API Console.
Si extraviaste tu clave criptográfica privada, accede a Google Cloud Support Portal y haz clic en Maps: Manage Client ID para recuperarla.
Genera una firma digital
Si intentas acceder a Directions API con una firma no válida, se mostrará el error HTTP 403 (Forbidden). A medida que conviertas tus aplicaciones para que empleen firmas de URL, prueba las firmas a fin de asegurarte de que inicien una solicitud válida. Primero debes probar si la URL original es válida y si se generan las firmas correctas.
Sigue estos pasos para crear una firma digital para tu solicitud:
-
Crea la URL de la solicitud sin la firma y asegúrate de incluir el parámetro
client. Ten en cuenta que cualquier carácter no estándar deberá estar codificado para direcciones URL:https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&client=clientIDNota: Todos los servicios de Google deben codificarse con caracteres UTF-8 (que implícitamente incluye ASCII). Si tus aplicaciones funcionan con otros conjuntos de caracteres, asegúrate de que creen direcciones URL con caracteres UTF-8 y que los codifiquen en formato URL correctamente.
-
Extrae la parte del dominio de la solicitud y deja solo la ruta a la consulta:
/maps/api/directions/json?origin=Toronto&destination=Montreal&client=clientID -
Obtén tu clave privada, codificada en Base64 modificado para URL, y firma la URL anterior con el algoritmo HMAC-SHA1. Es posible que debas decodificar esta firma a su formato binario original. Ten en cuenta que, en la mayoría de las bibliotecas criptográficas, la firma resultante estará en formato binario.
Nota: Base64 modificado para direcciones URL reemplaza los caracteres
+y/del Base64 estándar por-y_respectivamente, de modo que ya no es necesario codificar en formato URL las firmas Base64. -
Codifica la firma binaria resultante con Base64 modificado para direcciones URL para poder convertir esa firma en algo que pueda pasarse dentro de una URL.
-
Incluye esta firma en la URL dentro del parámetro
signature:https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&client=clientID&signature=base64signature
Para ver ejemplos de implementación de firmas de URL con código de servidor, consulta Ejemplo de código para firmas de URL.
Para firmar una URL ahora, ingresa a continuación tu URL y tu secreto de firma de URL. La URL debe contar con el formato descrito en el paso 1 anterior y debe estar codificada para direcciones URL.
Ejemplo de código para la firma de URL
En las siguientes secciones se muestra cómo implementar una firma de URL usando un código de servidor. Siempre debes firmas las URL en el servidor para evitar la exposición de tu clave criptográfica a los usuarios.
Python
El siguiente ejemplo usa bibliotecas Python estándar para firmar una URL. (Descargar el código).
#!/usr/bin/python
# -*- coding: utf-8 -*-
""" Signs a URL using a URL signing secret """
import hashlib
import hmac
import base64
import urlparse
def sign_url(input_url=None, secret=None):
""" Sign a request URL with a URL signing secret.
Usage:
from urlsigner import sign_url
signed_url = sign_url(input_url=my_url, secret=SECRET)
Args:
input_url - The URL to sign
secret - Your URL signing secret
Returns:
The signed request URL
"""
if not input_url or not secret:
raise Exception("Both input_url and secret are required")
url = urlparse.urlparse(input_url)
# We only need to sign the path+query part of the string
url_to_sign = url.path + "?" + url.query
# Decode the private key into its binary format
# We need to decode the URL-encoded private key
decoded_key = base64.urlsafe_b64decode(secret)
# Create a signature using the private key and the URL-encoded
# string using HMAC SHA1. This signature will be binary.
signature = hmac.new(decoded_key, url_to_sign, hashlib.sha1)
# Encode the binary signature into base64 for use within a URL
encoded_signature = base64.urlsafe_b64encode(signature.digest())
original_url = url.scheme + "://" + url.netloc + url.path + "?" + url.query
# Return signed URL
return original_url + "&signature=" + encoded_signature
if __name__ == "__main__":
input_url = raw_input("URL to Sign: ")
secret = raw_input("URL signing secret: ")
print "Signed URL: " + sign_url(input_url, secret)
Java
El siguiente ejemplo usa la clase java.util.Base64 disponible desde JDK 1.8; las versiones anteriores podrían necesitar Apache Commons o similares (Descargar el código).
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URISyntaxException;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.util.Base64; // JDK 1.8 only - older versions may need to use Apache Commons or similar.
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.net.URL;
import java.io.BufferedReader;
import java.io.InputStreamReader;
public class UrlSigner {
// Note: Generally, you should store your private key someplace safe
// and read them into your code
private static String keyString = "YOUR_PRIVATE_KEY";
// The URL shown in these examples is a static URL which should already
// be URL-encoded. In practice, you will likely have code
// which assembles your URL from user or web service input
// and plugs those values into its parameters.
private static String urlString = "YOUR_URL_TO_SIGN";
// This variable stores the binary key, which is computed from the string (Base64) key
private static byte[] key;
public static void main(String[] args) throws IOException,
InvalidKeyException, NoSuchAlgorithmException, URISyntaxException {
BufferedReader input = new BufferedReader(new InputStreamReader(System.in));
String inputUrl, inputKey = null;
// For testing purposes, allow user input for the URL.
// If no input is entered, use the static URL defined above.
System.out.println("Enter the URL (must be URL-encoded) to sign: ");
inputUrl = input.readLine();
if (inputUrl.equals("")) {
inputUrl = urlString;
}
// Convert the string to a URL so we can parse it
URL url = new URL(inputUrl);
// For testing purposes, allow user input for the private key.
// If no input is entered, use the static key defined above.
System.out.println("Enter the Private key to sign the URL: ");
inputKey = input.readLine();
if (inputKey.equals("")) {
inputKey = keyString;
}
UrlSigner signer = new UrlSigner(inputKey);
String request = signer.signRequest(url.getPath(),url.getQuery());
System.out.println("Signed URL :" + url.getProtocol() + "://" + url.getHost() + request);
}
public UrlSigner(String keyString) throws IOException {
// Convert the key from 'web safe' base 64 to binary
keyString = keyString.replace('-', '+');
keyString = keyString.replace('_', '/');
System.out.println("Key: " + keyString);
// Base64 is JDK 1.8 only - older versions may need to use Apache Commons or similar.
this.key = Base64.getDecoder().decode(keyString);
}
public String signRequest(String path, String query) throws NoSuchAlgorithmException,
InvalidKeyException, UnsupportedEncodingException, URISyntaxException {
// Retrieve the proper URL components to sign
String resource = path + '?' + query;
// Get an HMAC-SHA1 signing key from the raw key bytes
SecretKeySpec sha1Key = new SecretKeySpec(key, "HmacSHA1");
// Get an HMAC-SHA1 Mac instance and initialize it with the HMAC-SHA1 key
Mac mac = Mac.getInstance("HmacSHA1");
mac.init(sha1Key);
// compute the binary signature for the request
byte[] sigBytes = mac.doFinal(resource.getBytes());
// base 64 encode the binary signature
// Base64 is JDK 1.8 only - older versions may need to use Apache Commons or similar.
String signature = Base64.getEncoder().encodeToString(sigBytes);
// convert the signature to 'web safe' base 64
signature = signature.replace('+', '-');
signature = signature.replace('/', '_');
return resource + "&signature=" + signature;
}
}
C#
El siguiente ejemplo usa la biblioteca predeterminada System.Security.Cryptography para firmar una solicitud de URL. Ten en cuenta que debes convertir la codificación predeterminada Base64 para implementar una versión compatible con URL. (Descargar el código).
using System;
using System.Collections.Generic;
using System.Security.Cryptography;
using System.Text;
using System.Text.RegularExpressions;
using System.Web;
namespace SignUrl {
public struct GoogleSignedUrl {
public static string Sign(string url, string keyString) {
ASCIIEncoding encoding = new ASCIIEncoding();
// converting key to bytes will throw an exception, need to replace '-' and '_' characters first.
string usablePrivateKey = keyString.Replace("-", "+").Replace("_", "/");
byte[] privateKeyBytes = Convert.FromBase64String(usablePrivateKey);
Uri uri = new Uri(url);
byte[] encodedPathAndQueryBytes = encoding.GetBytes(uri.LocalPath + uri.Query);
// compute the hash
HMACSHA1 algorithm = new HMACSHA1(privateKeyBytes);
byte[] hash = algorithm.ComputeHash(encodedPathAndQueryBytes);
// convert the bytes to string and make url-safe by replacing '+' and '/' characters
string signature = Convert.ToBase64String(hash).Replace("+", "-").Replace("/", "_");
// Add the signature to the existing URI.
return uri.Scheme+"://"+uri.Host+uri.LocalPath + uri.Query +"&signature=" + signature;
}
}
class Program {
static void Main() {
// Note: Generally, you should store your private key someplace safe
// and read them into your code
const string keyString = "YOUR_PRIVATE_KEY";
// The URL shown in these examples is a static URL which should already
// be URL-encoded. In practice, you will likely have code
// which assembles your URL from user or web service input
// and plugs those values into its parameters.
const string urlString = "YOUR_URL_TO_SIGN";
string inputUrl = null;
string inputKey = null;
Console.WriteLine("Enter the URL (must be URL-encoded) to sign: ");
inputUrl = Console.ReadLine();
if (inputUrl.Length == 0) {
inputUrl = urlString;
}
Console.WriteLine("Enter the Private key to sign the URL: ");
inputKey = Console.ReadLine();
if (inputKey.Length == 0) {
inputKey = keyString;
}
Console.WriteLine(GoogleSignedUrl.Sign(inputUrl,inputKey));
}
}
}
Si deseas realizar pruebas, puedes probar la URL y clave privada siguientes para corroborar que generen la firma correcta. Ten en cuenta que esta clave privada solo sirve para realizar pruebas y no recibirá validación de ninguno de los servicios de Google.
- URL:
https://maps.googleapis.com/maps/api/geocode/json?address=New+York&client=clientID - Clave privada:
vNIXE0xscrmjlyV-12Nj_BvUPaw= - Parte de la URL que se firmará:
/maps/api/geocode/json?address=New+York&client=clientID - Firma:
chaRF2hTJKOScPr-RQCEhZbSzIE= - URL completa y firmada:
https://maps.googleapis.com/maps/api/geocode/json?address=New+York&client=clientID&signature=chaRF2hTJKOScPr-RQCEhZbSzIE=
Ejemplos en otros idiomas
Encontrarás ejemplos con más idiomas en el proyecto de firmas de URL.
Solución de problemas de autenticación
Si tu solicitud no tiene el formato correcto o proporciona una firma no válida, Google Maps Directions API devuelve un error HTTP 403 (Forbidden).
Para solucionar problemas en direcciones URL individuales, puedes usar el URL Signing Debugger. Este depurador te permitirá validar rápidamente una URL y la firma que generó tu aplicación.
Como alternativa, los clientes de Google Maps APIs Premium Plan pueden solucionar los problemas de las URL accediendo al Google Cloud Support Portal y seleccionando Resources > Google Maps APIs Premium Plan online tools > URL Signing Debugger for Web Service and Image APIs.
