API de Maps JavaScript: Obtén una clave de API o un ID de cliente

Nota: El plan Premium de Google Maps Platform ya no está disponible para registros o clientes nuevos.

Cómo elegir un método de autenticación

Para usar la API de Maps JavaScript:

  • Los clientes del plan Premium pueden usar una clave de API o un ID de cliente para autenticar las solicitudes.
  • Los clientes con una licencia anterior deben usar un ID de cliente para autenticar las solicitudes.

A continuación, se resumen las herramientas y los informes disponibles con cada método de autenticación:

  • Autenticación con una clave de API (plan Premium)
    Si usas una clave de API para autenticar tu solicitud, puedes hacer lo siguiente:
    • Administrar todas tus API en la página de API en Google Cloud Console
    • Acceder a datos de uso en tiempo real y a 30 días de datos de uso históricos en Cloud Console
    • Agregar el parámetro channel a las solicitudes para poder ver informes de uso más detallados
    • Consultar los informes de uso con más de 30 días de datos en Cloud Console
  • Autenticación con un ID de cliente (plan Premium o licencia anterior)
    Si usas un ID de cliente para autenticar tu solicitud, puedes hacer lo siguiente:
    • Agregar el parámetro channel a las solicitudes para poder ver informes de uso más detallados
    • Consultar los informes de uso con más de 30 días de datos en Cloud Console
    • Usar las herramientas de Maps Analytics para la API de Maps JavaScript

Obtén más información sobre los informes disponibles para los clientes del plan premium.

Autenticación con una clave de API

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:

  1. En Cloud Console, en la página del selector de proyectos, selecciona o crea un proyecto de Google Cloud para el que desees agregar una clave de API.

    Ir a la página del selector de proyectos

    Nota: Para tener acceso completo a las funciones de su plan, los clientes premium deben usar el proyecto asociado con su cuenta premium. Cuando compraste tu licencia, recibiste el nombre de tu elemento Premium en el siguiente formato: gme-[company] & proj-[number] ([type]). Para asegurarte de utilizar el proyecto correcto, accede a la consola como el propietario del proyecto mediante console.cloud.google.com/project/number (reemplaza number por tu número de proyecto). Puedes ver el propietario del proyecto en tu carta de bienvenida.

  2. Ve a la página API y servicios > Credenciales.

    Ir a la página Credenciales

  3. 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.
  4. 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.

Cómo agregar la clave de API a tu app

Debes incluir una clave de API con cada solicitud de Google Maps Platform. En el siguiente ejemplo, reemplaza YOUR_API_KEY por tu clave de API.

<script async defer src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap"
type="text/javascript"></script>

Cómo restringir las claves de API

La restricción de las claves de API agrega seguridad a tu aplicación, ya que garantiza que solo se realicen solicitudes autorizadas con tu clave de API. Te recomendamos enfáticamente que sigas las instrucciones si deseas configurar restricciones para tus claves de API. Para obtener más información, consulta Prácticas recomendadas sobre las claves de API.

Para restringir una clave de API, sigue estos pasos:

  1. Ve a la página API y servicios > 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 las solicitudes de la lista del sitio web que proporcionas, selecciona URL de referencia HTTP (sitios web) en la lista de Restricciones de aplicaciones.
      2. Especifica uno o más sitios web con URL de referencia. Por ejemplo, *.google.com acepta todos los sitios que terminan en google.com, como https://developers.google.com.

        Nota: Las URL de referencia file:// necesitan que se agregue una representación especial a la restricción de clave. La parte "file://" debe reemplazarse por "__file_url__" antes de agregarse a la restricción. Por ejemplo, "file:///path/to/" debe tener el formato "__file_url__//path/to/*". Después de habilitar las URL de referencia file://, se recomienda que revises tu uso periódicamente para asegurarte de que coincida con tus expectativas.

    • Restricciones de API:
      1. Haz clic en Restringir clave.
      2. Selecciona Google Maps Platform en el menú desplegable Seleccionar API. Si Google Maps Platform no aparece en la lista, debes habilitarlo.
      3. Si en tu proyecto se usa la Biblioteca de Places, también selecciona API de Places. Del mismo modo, si en tu proyecto se usan otros servicios de la API de JavaScript (Servicio de instrucciones sobre cómo llegar ,Servicio de matriz de distancia ,Servicio de elevación o Servicio de geocodificación ), también debes habilitar y seleccionar la API correspondiente en esta lista.
  4. Para finalizar los cambios, haz clic en Guardar.

Autenticación con un ID de cliente

Cuando compres tu licencia del plan premium de Google Maps Platform, Google te enviará un correo electrónico de bienvenida con tu ID de cliente, el cual te permite acceder a los diferentes informes y herramientas del plan premium de Google Maps Platform.

Todos los ID de cliente comienzan con un prefijo gme-. A continuación, se muestra el formato de un ID de cliente típico.

gme-[empresa] & proj-[número] ([tipo])

Puedes autenticar tus solicitudes con la API de Maps JavaScript mediante un ID de cliente en combinación con el registro de URL (en lugar de una clave de API).

Nota: Este ID de cliente no es una clave, y solo pueden utilizarlo las URL que autorices. Obtén más información sobre cómo registrar URL autorizadas.

Cómo especificar un ID de cliente al cargar la API

En el código que aparece a continuación, se muestra cómo reemplazar YOUR_CLIENT_ID con tu propio ID de cliente al cargar la API de Maps JavaScript.

  <script async defer
  src="https://maps.googleapis.com/maps/api/js?client=YOUR_CLIENT_ID&v=quarterly&callback=initMap"></script>

Debes anexar un parámetro v=quarterly para especificar la versión de actualización (también llamada versión con funciones estables) o una versión anterior. Las aplicaciones que usan la versión experimental no están cubiertas por el ANS del plan Premium de Google Maps Platform.

Nota: 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 antes de cargar la API. No se cargará la API si se incluyen tanto un ID de cliente como una clave de API.

Cómo registrar las URL autorizadas

Para evitar que un tercero pueda utilizar tu ID de cliente en su sitio web, debes autorizar específicamente una lista de las URL en las que se lo puede usar.

Para ver las URL que ya autorizaste o para autorizar otras, realiza lo siguiente:

  1. Accede a Google Cloud Console.
  2. En el menú lateral izquierdo, haz clic en Maps: Administrar ID de cliente.

Puedes agregar hasta 100 URL a la vez. Un ID de cliente se puede asociar con hasta 3,000 URL autorizadas. Si esperas que tu aplicación aloje contenido de Google Maps de más de 3,000 ubicaciones, debes comenzar a utilizar claves de API.

Ten en cuenta las siguientes consideraciones respecto de las URL autorizadas:

El nombre de dominio o la dirección IP no deben ser de acceso público.
Por ejemplo, http://myintranet y http://192.168.1.1 son entradas válidas.
También se autorizan todos los subdominios de un dominio especificado.
Por ejemplo, si se autoriza http://example.com, también se autoriza http://www.example.com. Esto no es así en la situación inversa: si se autoriza http://www.example.com, no necesariamente se autoriza http://example.com.
También se autorizan todas las subrutas una ruta de acceso autorizada.
Por ejemplo, si se autoriza http://example.com, también se autoriza http://example.com/foo. Además, debido a que también se autorizan los subdominios de un dominio especificado, http://sub.example.com/bar queda autorizado.
Para las rutas de acceso, se distinguen mayúsculas de minúsculas.
Por ejemplo, http://www.example.com/ThisPath/ no es lo mismo que http://www.example.com/thispath/.
Puedes restringir las URL válidas a aquellas que utilicen determinados puertos.
Por ejemplo, si se especifica http://example.com:8080/foo, eso no significa que la URL http://example.com esté autorizada.
Los protocolos HTTP y HTTPS se consideran como URL distintas.
Por ejemplo, si se autoriza https://example.com, eso no significa que la URL http://example.com esté necesariamente autorizada.

Todas las reglas descritas anteriormente se aplican a cada autorización. Por lo tanto, debes planificar con cuidado las autorizaciones. Por ejemplo, dado que se autorizan todas las subrutas de una ruta de acceso especificada, así como todos los subdominios, es posible que autorices páginas que no tenías previstas. Por ejemplo:

http://example.com/ también autoriza http://sub.example.com/path.

Para obtener más información, consulta Cómo solucionar problemas de autorización de URL del plan premium de Google Maps Platform.