Używanie kluczy interfejsu API z interfejsem Maps Static API

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Usługi Google Maps Platform są chronione przed nieautoryzowanym użyciem, ograniczając wywołania interfejsu API do tych, które udostępniają prawidłowe dane uwierzytelniające. Dane logowania mają postać klucza interfejsu API – unikalnego ciągu alfanumerycznego, który łączy konto rozliczeniowe Google z Twoim projektem i z konkretnym interfejsem API lub pakietem SDK.

Z tego przewodnika dowiesz się, jak utworzyć i ograniczyć dostęp do klucza interfejsu API oraz jak go używać w Google Maps Platform.

Zanim zaczniesz

Zanim zaczniesz korzystać z statycznego interfejsu API Map Google, musisz mieć projekt z kontem rozliczeniowym i włączony ten interfejs. Więcej informacji znajdziesz w artykule Konfiguracja w Cloud Console.

Tworzenie kluczy interfejsu API

Klucz interfejsu API jest unikalnym identyfikatorem uwierzytelniającym żądania powiązane z Twoim projektem na potrzeby użytkowania i rozliczeń. Musisz mieć co najmniej jeden klucz interfejsu API powiązany z Twoim projektem.

Aby utworzyć klucz interfejsu API:

Konsola

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

    Otwórz stronę Dane logowania

  2. Na stronie Dane logowania kliknij Utwórz dane logowania &klucz API.
    W oknie Utworzono klucz API pojawi się nowo utworzony klucz.
  3. Kliknij Zamknij.
    Nowy klucz interfejsu API znajdziesz na stronie Dane logowania w sekcji Klucze interfejsu API.
    (Pamiętaj, aby ograniczyć dostęp do klucza interfejsu API przed użyciem go w środowisku produkcyjnym).

(pakiet) SDK Cloud

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

Dowiedz się więcej o pakietach Google Cloud SDK, instalacji Cloud SDK i o tych poleceniach:

Ograniczenie kluczy interfejsu API

Zdecydowanie zalecamy ograniczenie kluczy interfejsu API tylko do tych interfejsów API, których potrzebujesz w przypadku swojej aplikacji. Ograniczenie kluczy interfejsu API zwiększa bezpieczeństwo aplikacji, chroniąc ją przed nieuzasadnionymi żądaniami. Więcej informacji znajdziesz w artykule o sprawdzonych metodach zabezpieczania interfejsu API.

Aby ograniczyć klucz interfejsu API:

Konsola

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

    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. Aby akceptować żądania z listy podanych adresów IP serwerów WWW, wybierz Adresy IP (serwery WWW, zadania cron itp.) z listy Ograniczenia aplikacji. Podaj jeden adres IPv4 lub IPv6 albo podsieć w notacji CIDR (np. 192.168.0.0/22). Żądanie usługi internetowej usługi sprawdza i porównuje zewnętrzny adres IP z ograniczeniem klucza interfejsu API, więc użyj publicznego adresu IP serwera.
    • Ograniczenia interfejsów API:
      1. Kliknij Ogranicz klucz.
      2. Wybierz Map Static API z menu Wybierz interfejsy API. Jeśli na liście nie widzisz interfejsu statycznego interfejsu API Map Google, musisz go włączyć.
  4. Aby zapisać zmiany, kliknij Zapisz.

(pakiet) SDK Cloud

Wyświetlenie listy istniejących kluczy.

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

Wyczyść istniejące ograniczenia istniejącego klucza.

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

Ustaw nowe ograniczenia dotyczące dotychczasowego klucza.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api_target="static-maps-backend.googleapis.com"
    --allowed-ips="IP_ADDRESS"

Dowiedz się więcej o pakietach Google Cloud SDK, instalacji Cloud SDK i o tych poleceniach:

Dodawanie klucza interfejsu API do żądania

Do każdego żądania dotyczącego statycznego interfejsu API Map Google musisz dołączyć klucz interfejsu API. W poniższym przykładzie zastąp YOUR_API_KEY kluczem interfejsu API.

https://maps.googleapis.com/maps/api/staticmap?center=40.714%2c%20-73.998&zoom=12&size=400x400&key=YOUR_API_KEY

W przypadku żądań korzystających z klucza interfejsu API wymagany jest protokół HTTPS.

Co dalej

W przypadku żądań interfejsu Statyczny interfejs API Map Google należy używać podpisu cyfrowego.