Korzystanie z kluczy interfejsu API

Wybierz platformę: Android iOS JavaScript

Zanim zaczniesz

Zanim zaczniesz korzystać z pakietu Maps SDK na Androida, musisz mieć projekt z kontem rozliczeniowym i włączonym pakietem Maps SDK na Androida. Więcej informacji znajdziesz w artykule Konfiguracja w Cloud Console.

Tworzenie kluczy interfejsu API

Klucz interfejsu API to unikalny identyfikator, który uwierzytelnia żądania powiązane z Twoim projektem w celach związanych z użytkowaniem i rozliczeniami. 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 zostanie wyświetlony 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 przed użyciem klucza interfejsu API ograniczyć jego użycie).

(pakiet) SDK Cloud

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

Dowiedz się więcej o pakiecie SDK Google Cloud, instalacji pakietu SDK Cloud oraz tych poleceniach:

Ograniczanie kluczy interfejsu API

Google zdecydowanie zaleca ograniczenie użycia kluczy interfejsu API do tych interfejsów API, których aplikacja potrzebuje tylko do tych interfejsów. Ograniczenie kluczy interfejsu API zwiększa bezpieczeństwo aplikacji przez ochronę przed niechcianymi żądaniami. Więcej informacji znajdziesz w artykule ze sprawdzonymi metodami zapewniania bezpieczeństwa interfejsu API.

Jeśli ograniczasz swój klucz interfejsu API, musisz podać odcisk cyfrowy certyfikatu SHA-1 klucza podpisywania użytego do podpisania aplikacji. Istnieją 2 typy certyfikatów:

  • Certyfikat debugowania: używaj certyfikatu tego typu tylko w przypadku testowanych aplikacji i innego kodu nieprodukcyjnego. Nie próbuj publikować aplikacji podpisanej certyfikatem debugowania. Narzędzia Android SDK generują ten certyfikat automatycznie podczas uruchamiania kompilacji do debugowania.
  • Certyfikat wersji: użyj tego certyfikatu, gdy chcesz opublikować aplikację w sklepie z aplikacjami. Narzędzia pakietu Android SDK generują ten certyfikat podczas uruchamiania kompilacji do wersji.

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

Instrukcje, jak znaleźć odcisk cyfrowy certyfikatu podpisywania, znajdziesz w tych artykuł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 ustawić ograniczenie. Pojawi się strona właściwości klucza interfejsu API.
  3. W sekcji Ograniczenia klucza ustaw te ograniczenia:
    • Ograniczenia aplikacji:
      1. Wybierz Aplikacje na Androida.
      2. Kliknij + Dodaj nazwę pakietu i odcisk palca.
      3. Wpisz nazwę pakietu i odcisk cyfrowy certyfikatu SHA-1. Na 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. Wybierz Pakiet SDK Map Google na Androida z menu Wybierz interfejsy API. Jeśli nie widzisz pakietu SDK Map Google na Androida, musisz go włączyć.
  4. Aby zastosować zmiany, kliknij Zapisz.

(pakiet) SDK Cloud

Wyświetl listę istniejących kluczy.

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

Usuń istniejące ograniczenia dotyczące istniejącego klucza.

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

Ustaw nowe ograniczenia 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"

Dowiedz się więcej o pakiecie SDK Google Cloud, instalacji pakietu SDK Cloud oraz tych poleceniach:

Co dalej?

Gdy masz już klucz interfejsu API, utwórz i skonfiguruj projekt zgodnie z opisem w artykule Konfigurowanie projektu Android Studio.