Korzystanie z kluczy interfejsu API w interfejsie Roads API

Produkty Google Maps Platform są chronione przed nieuprawnionym użyciem przez ograniczenie wywołań interfejsu API do tych, które zapewniają odpowiednie dane logowania. Te dane logowania mają postać klucza interfejsu API – unikalnego ciągu alfanumerycznego, który łączy Twoje konto rozliczeniowe Google z projektem oraz z konkretnym interfejsem API lub pakietem SDK.

Z tego przewodnika dowiesz się, jak utworzyć klucz interfejsu API Google Maps Platform, ograniczyć jego użycie i z niego korzystać.

Zanim zaczniesz

Zanim zaczniesz korzystać z interfejsu Roads API, musisz mieć projekt z włączonym kontem rozliczeniowym i interfejsem Roads API. Więcej informacji znajdziesz w artykule Konfigurowanie w konsoli Google Cloud.

Tworzenie kluczy interfejsu API

Klucz interfejsu API to unikalny identyfikator używany do uwierzytelniania żądań powiązanych z projektem na potrzeby wykorzystania i rozliczania. Z projektem musi być powiązany co najmniej 1 klucz API.

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 API wyświetli się nowo utworzony klucz API.
  3. Kliknij Zamknij.
    Nowy klucz interfejsu API pojawi się na stronie Dane logowania w sekcji Klucze API.
    (Pamiętaj, aby ograniczyć dostęp do klucza API przed użyciem go w środowisku produkcyjnym).

Pakiet SDK Cloud

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

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

Ograniczanie kluczy interfejsu API

Zdecydowanie zalecamy ograniczenie kluczy interfejsu API tylko do tych interfejsów API, które są potrzebne do działania aplikacji. Ograniczenie dostępu do kluczy interfejsu API zwiększa bezpieczeństwo aplikacji, chroniąc ją przed nieuzasadnionymi żądaniami. Odpowiadasz finansowo za opłaty spowodowane nadużywaniem kluczy interfejsu API bez ograniczeń. Aby dowiedzieć się więcej, zapoznaj się ze sprawdzonymi metodami zapewniania bezpieczeństwa interfejsu API.

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 usługi klucza interfejsu API.
  3. W sekcji Ograniczenia klucza ustaw te ograniczenia:
    • Ograniczenia aplikacji:
      1. Aby akceptować żądania z listy podanych przez Ciebie adresów IP serwera WWW, na liście Ograniczenia aplikacji wybierz Adresy IP (serwery WWW, zadania cron itp.). Podaj co najmniej 1 adres IPv4 lub IPv6 albo podsieć w notacji CIDR. Adresy IP muszą być zgodne z adresem źródłowym, który rejestrują serwery Google Maps Platform. Jeśli korzystasz z translacji adresów sieciowych (NAT), będzie to zwykle odpowiadać publicznemu adresowi IP Twojego urządzenia.
    • Ograniczenia interfejsów API:
      1. Kliknij Ogranicz dostęp do klucza.
      2. Na liście Wybierz interfejsy API kliknij Interfejs API dróg. Jeśli interfejs API Roads nie jest na liście, musisz go włączyć.
  4. Aby zatwierdzić zmiany, kliknij Zapisz.

Pakiet SDK Cloud

Lista istniejących kluczy. 

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

usunąć istniejące ograniczenia dotyczące dotychczasowego klucza. 

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

Ustaw nowe ograniczenia dla istniejącego klucza. 

gcloud services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=roads.googleapis.com
    --allowed-ips="IP_ADDRESS"

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

Dodawanie klucza interfejsu API do żądania

W każdym żądaniu do interfejsu Roads API musisz podać klucz interfejsu API. W tym przykładzie zastąp YOUR_API_KEY swoim kluczem API.

https://roads.googleapis.com/v1/snapToRoads?path=-35.27801,149.12958|-35.28032,149.12907|-35.28099,149.12929|-35.28144,149.12984|-35.28194,149.13003|-35.28282,149.12956|-35.28302,149.12881|-35.28473,149.12836 &interpolate=true &key=YOUR_API_KEY

W przypadku żądań, które używają klucza interfejsu API, wymagany jest protokół HTTPS.