Cómo usar claves de API

Seleccionar plataforma: Android iOS JavaScript

En este tema, se describe cómo crear una clave de API para el SDK de Maps para Android, agregarla a tu app y protegerla mediante la restricción de la clave. Debes agregar una clave de API a toda app que use el SDK.

Antes de comenzar

A fin de comenzar a utilizar el SDK de Maps para Android, debes habilitarlo y tener un proyecto con una cuenta de facturación. 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.

Cuando restringes tu clave de API, debes proporcionar la huella digital del certificado SHA-1 de la clave que se usó para firmar la aplicación. Existen dos tipos de certificados:

  • Certificado de depuración: Usa este tipo de certificado solo con apps que estés probando y con otros códigos que no sean de producción. No intentes publicar una app firmada con un certificado de depuración. Las herramientas del SDK de Android generan este certificado automáticamente cuando ejecutas una compilación de depuración.
  • Certificado de lanzamiento: Usa este certificado cuando estés listo para lanzar tu app en una tienda de aplicaciones. Las herramientas del SDK de Android generan este certificado cuando ejecutas una compilación de lanzamiento.

Para obtener más información sobre los certificados digitales, consulta la guía Firma tu app.

Para obtener más información sobre cómo obtener la huella digital de tu certificado, consulta Autentica tu cliente. En cambio, si usas la firma de apps de Play, debes ir a la página de firma de apps en Play Console para obtener la huella digital del certificado.

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. Selecciona Apps de Android.
      2. Haz clic en + Agregar nombre del paquete y huella digital.
      3. Ingresa el nombre del paquete y la huella digital del certificado SHA-1. Por ejemplo:
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • Restricciones de API:
      1. Haz clic en Restringir clave.
      2. Selecciona SDK de Maps para Android en el menú desplegable Seleccionar API. Si el SDK de Maps para Android no aparece en la lista, debes habilitarlo.
  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="maps-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

¿Cuáles son los siguientes pasos?

Ahora que tienes una clave de API, crea y configura un proyecto tal como se describe en Cómo configurar un proyecto de Android Studio.