Utilizzo di chiavi API

Seleziona piattaforma: Android iOS JavaScript

Questo argomento descrive come creare una chiave API per l'SDK di Maps per Android, aggiungerla alla tua app e proteggerla limitando la chiave. Devi aggiungere una chiave API a qualsiasi app che utilizza l'SDK.

Prima di iniziare

Prima di iniziare a utilizzare Maps SDK for Android, è necessario un progetto con un account di fatturazione e Maps SDK for Android. Per scoprire di più, consulta Configurare Cloud Console.

Creazione di chiavi API

La chiave API è un identificatore univoco che autentica le richieste associate al tuo progetto ai fini dell'utilizzo e della fatturazione. Devi avere almeno una chiave API associata al tuo progetto.

Per creare una chiave API:

console

  1. Vai alla pagina Google Maps Platform > Credentials (Credenziali).

    Vai alla pagina Credenziali

  2. Nella pagina Credenziali, fai clic su Crea credenziali > chiave API.
    Nella finestra di dialogo Chiave API creata viene visualizzata la chiave API appena creata.
  3. Fai clic su Chiudi.
    La nuova chiave API è elencata nella pagina Credenziali in Chiavi API.
    Ricorda di limitare la chiave API prima di utilizzarla in produzione.

Cloud SDK

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

Scopri di più su Google Cloud SDK , Installazione di Cloud SDK e sui seguenti comandi:

Limitazione delle chiavi API

Google consiglia vivamente di limitare le chiavi API limitandone l'utilizzo alle sole API necessarie per l'applicazione. La limitazione delle chiavi API rafforza la sicurezza della tua applicazione proteggendola dalle richieste ingiustificate. Per ulteriori informazioni, consulta le best practice per la sicurezza delle API.

Quando limiti la chiave API, devi fornire l'impronta digitale del certificato SHA-1 della chiave di firma utilizzata per firmare l'applicazione. Esistono due tipi di certificati:

  • Certificato di debug: utilizza questo tipo di certificato solo con le app che stai testando e con altro codice non di produzione. Non tentare di pubblicare un'app firmata con un certificato di debug. Gli strumenti SDK Android generano questo certificato automaticamente quando esegui una build di debug.
  • Rilascia il certificato: utilizza questo certificato quando vuoi rilasciare l'app in uno store. Gli strumenti dell'SDK Android generano questo certificato quando esegui una build di release.

Per scoprire di più sui certificati digitali, consulta la guida Firmare l'app.

Per informazioni su come ottenere l'impronta del certificato, consulta l'articolo su come autenticare il client. Se utilizzi la firma dell'app di Google Play, devi andare alla pagina di firma dell'app su Play Console per ottenere l'impronta del certificato.

Per limitare una chiave API:

console

  1. Vai alla pagina Google Maps Platform > Credentials (Credenziali).

    Vai alla pagina Credenziali

  2. Seleziona la chiave API per cui vuoi impostare una limitazione. Viene visualizzata la pagina di proprietà della chiave API.
  3. In Limitazioni principali, imposta le seguenti restrizioni:
    • Restrizioni delle applicazioni:
      1. Seleziona App Android.
      2. Fai clic su + Aggiungi nome pacchetto e impronta.
      3. Inserisci il nome del pacchetto e l'impronta digitale del certificato SHA-1. Ad esempio:
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • Restrizioni delle API:
      1. Fai clic su Limita la chiave.
      2. Seleziona SDK Maps per Android nel menu a discesa Seleziona API. Se l'SDK Maps per Android non è presente nell'elenco, devi attivarlo.
  4. Per finalizzare le modifiche, fai clic su Salva.

Cloud SDK

Elenca le chiavi esistenti.

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

Cancella le limitazioni esistenti sulla chiave esistente.

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

Imposta nuove restrizioni sulla chiave esistente.

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"

Scopri di più su Google Cloud SDK , Installazione di Cloud SDK e sui seguenti comandi:

Che cosa succede a questo punto

Ora che hai una chiave API, crea e configura un progetto come descritto nell'articolo Configurare un progetto Android Studio.