Korzystanie z kluczy interfejsu API

Tworzę klucze interfejsu API

Klucz interfejsu API to unikalny identyfikator, który uwierzytelnia żądania powiązane z Twoim projektem na potrzeby użytkowania i rozliczeń. Musisz mieć co najmniej 1 klucz interfejsu API powiązany z projektem.

Aby utworzyć klucz interfejsu API:

Konsola

  1. Otwórz stronę Google Maps Platform > Dane logowania.

    Otwórz stronę Dane logowania

  2. Na stronie Dane logowania kliknij Utwórz dane logowania > Klucz interfejsu API.
    W oknie Utworzono klucz interfejsu API pojawi się nowo utworzony klucz interfejsu API.
  3. Kliknij Zamknij.
    Nowy klucz interfejsu API znajdziesz na stronie Dane logowania w sekcji Klucze interfejsu API.
    (Pamiętaj, aby ograniczyć klucz interfejsu API, zanim użyjesz go w środowisku produkcyjnym.

(pakiet) SDK Cloud

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

Przeczytaj więcej o Google Cloud SDK, instalacji pakietu SDK Cloud i poniższych poleceniach:

Ograniczanie kluczy interfejsu API

Zdecydowanie zalecamy ograniczenie ich użycia do tych interfejsów API, które są niezbędne dla Twojej aplikacji. Ograniczenie kluczy interfejsu API zwiększa bezpieczeństwo aplikacji przez ochronę jej przed nieuzasadnionymi żądaniami. Więcej informacji znajdziesz w artykule o sprawdzonych metodach zabezpieczania interfejsów API.

W przypadku ograniczenia klucza interfejsu API musisz podać odcisk cyfrowy certyfikatu SHA-1 klucza podpisywania, który został użyty do podpisania aplikacji. Istnieją 2 typy certyfikatów:

  • Certyfikat debugowania: używaj tego typu certyfikatu tylko w przypadku testowanych aplikacji oraz z innym kodem nieprodukcyjnym. Nie próbuj publikować aplikacji, która jest podpisana certyfikatem debugowania. Narzędzia Android SDK generują ten certyfikat automatycznie podczas uruchamiania kompilacji do debugowania.
  • Certyfikat wersji: użyj tego certyfikatu, gdy zechcesz udostępnić aplikację w sklepie z aplikacjami. Narzędzia Android SDK generują ten certyfikat podczas uruchamiania kompilacji wersji.

Więcej informacji o podpisywaniu aplikacji na Androida i certyfikatach znajdziesz w przewodniku podpisywanie aplikacji.

Instrukcje dotyczące znajdowania odcisku cyfrowego certyfikatu podpisywania znajdziesz w tych materiałach:

Aby ograniczyć klucz interfejsu API:

Konsola

  1. Otwórz stronę Google Maps Platform > Dane logowania.

    Otwórz stronę Dane logowania

  2. Wybierz klucz interfejsu API, dla którego chcesz zastosować ograniczenie. Pojawi się strona właściwości klucza interfejsu API.
  3. W sekcji Ograniczenia kluczy ustaw te ograniczenia:
    • Ograniczenia aplikacji:
      1. Wybierz Aplikacje na Androida.
      2. Kliknij + Dodaj nazwę pakietu i odcisk cyfrowy.
      3. Wpisz nazwę pakietu i odcisk cyfrowy certyfikatu SHA-1. Przykład: 
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • Ograniczenia interfejsów API:
      1. Kliknij Ogranicz klucz.
      2. Z menu Wybierz interfejsy API wybierz Navigation SDK. Jeśli pakietu Navigation SDK nie ma na liście, musisz go enable.
  4. Aby zastosować zmiany, kliknij Zapisz.

(pakiet) SDK Cloud

Wyświetl listę istniejących kluczy. 

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

Usuń ograniczenia dotyczące istniejącego klucza. 

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

Ustaw nowe ograniczenia dla istniejącego klucza. 

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"

Przeczytaj więcej o Google Cloud SDK, instalacji pakietu SDK Cloud i poniższych poleceniach: