Używanie kluczy interfejsu API z Directions API (starsza wersja)

Usługi Google Maps Platform są zabezpieczone przed nieuprawnionym użyciem, ponieważ wywołania interfejsu API są ograniczone do tych, które zawierają prawidłowe dane uwierzytelniające. Te dane logowania mają postać klucza interfejsu API, który jest unikalnym ciągiem alfanumerycznym powiązującym Twoje konto rozliczeniowe Google z projektem oraz z konkretnym interfejsem API lub pakietem SDK.

Dowiedz się, jak utworzyć, ograniczyć i używać klucza interfejsu API w Google Maps Platform.

Zanim zaczniesz

Zanim zaczniesz korzystać z interfejsu Directions API (starsza wersja), musisz mieć projekt z kontem rozliczeniowym i włączonym interfejsem Directions API (starsza wersja). Więcej informacji znajdziesz w artykule o konfigurowaniu w konsoli Cloud.

Tworzenie kluczy interfejsu API

Klucz interfejsu API to unikalny identyfikator używany do uwierzytelniania żądań powiązanych z projektem na potrzeby wykorzystania i płatności. Z projektem musi być powiązany co najmniej 1 klucz interfejsu API. Aby utworzyć nowy klucz lub dodać interfejs API bądź pakiet SDK do istniejącego klucza, wykonaj te instrukcje.

Konsola

  1. Otwórz stronę Google Maps Platform > Klucze i dane logowania.

    Otwórz stronę Klucze i dane uwierzytelniające

  2. Jeśli pojawi się taka prośba, wybierz projekt.

  3. Wykonaj jedną z tych czynności:

    • Utwórz nowy klucz:

      1. Kliknij Utwórz dane logowania > Klucz interfejsu API.
      2. W panelu Utwórz klucz interfejsu API otwórz listę Wybierz ograniczenia interfejsu API.
      3. Odznacz wszystkie interfejsy API, których ten klucz nie potrzebuje, i upewnij się, że Directions API pozostaje zaznaczony.
      4. Kliknij Utwórz. W panelu pojawi się nowy klucz interfejsu API.

    • Użyj istniejącego klucza:

      1. Kliknij nazwę klucza.
      2. Na liście Wybierz ograniczenia interfejsu API wybierz Directions API.
      3. Kliknij Zapisz.

    Wybranie interfejsu API w tym miejscu nie powoduje jego włączenia. Upewnij się, że interfejs Directions API jest włączony na stronie Biblioteka API.

  4. Aby później wyświetlić ciąg klucza, otwórz stronę Klucze i dane uwierzytelniające i kliknij Pokaż klucz.

Jeśli konsola wygląda inaczej niż w tych krokach, zapoznaj się z artykułami Tworzenie klucza interfejsu API i Dodawanie ograniczeń interfejsu API w dokumentacji Google Cloud.

gcloud

W poniższych poleceniach zastąp PROJECT_ID identyfikatorem swojego projektu.

  • Utwórz nowy klucz: uruchom to polecenie i zastąp DISPLAY_NAME nazwą klucza. 

    gcloud services api-keys create \
    --project="PROJECT_ID" \
    --display-name="DISPLAY_NAME" \
    --api-target=service=directions-backend.googleapis.com

    Więcej informacji o pakiecie SDK Google Cloud, instalacji pakietu SDK Cloud i tych poleceniach:

  • Użyj istniejącego klucza: uruchom to polecenie i zastąp KEY_ID identyfikatorem klucza. Flaga --append zachowuje interfejsy API, które klucz już dopuszcza. Bez niego polecenie zastępuje je.

    gcloud services api-keys update KEY_ID \
    --project="PROJECT_ID" \
    --append \
    --api-target=service=directions-backend.googleapis.com

    Więcej informacji o pakiecie SDK Google Cloud, instalacji pakietu SDK Cloud i tych poleceniach:

    Identyfikator klucza nie jest ciągiem klucza ani wyświetlaną nazwą. Aby go znaleźć, uruchom gcloud services api-keys list --project="PROJECT_ID". Identyfikator to ostatnia część pola name: projects/PROJECT_NUMBER/locations/global/keys/KEY_ID.

Aby zobaczyć ciąg klucza, uruchom gcloud services api-keys get-key-string KEY_ID --project="PROJECT_ID".

Ogranicz klucze interfejsu API

Google zdecydowanie zaleca ograniczenie kluczy interfejsu API przez ograniczenie ich użycia tylko do interfejsów API potrzebnych w aplikacji. Ograniczenie kluczy interfejsu API zwiększa bezpieczeństwo aplikacji, chroniąc ją przed nieuzasadnionymi żądaniami. Ponosisz odpowiedzialność finansową za opłaty spowodowane nadużyciem kluczy interfejsu API bez ograniczeń. Więcej informacji znajdziesz w artykule Sprawdzone metody dotyczące bezpieczeństwa interfejsów API.

Aby ograniczyć klucz interfejsu API:

Konsola

  1. Otwórz stronę Google Maps Platform > Klucze i dane logowania.

    Otwórz stronę Klucze i dane uwierzytelniające

  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 przez Ciebie adresów IP serwerów WWW, w sekcji Ograniczenia aplikacji wybierz Adresy IP. Podaj co najmniej jeden adres IPv4 lub IPv6 albo podsieć w notacji CIDR. Adresy IP muszą być zgodne z adresem źródłowym, który widzą serwery Google Maps Platform. Jeśli używasz translacji adresów sieciowych (NAT), zwykle odpowiada to publicznemu adresowi IP komputera.
    • Ograniczenia interfejsów API:
      1. W sekcji Wybierz ograniczenia interfejsu API sprawdź, czy wybrany jest Directions API. Jeśli nie ma jej na liście, musisz ją włączyć.
  4. Aby zapisać zmiany, kliknij Zapisz.

gcloud

Uruchom podane niżej polecenie. Zastąp KEY_ID identyfikatorem klucza, a PROJECT_ID identyfikatorem projektu. Aby znaleźć identyfikator klucza, uruchom polecenie gcloud services api-keys list --project="PROJECT_ID". Identyfikator to ostatnia część pola name.

gcloud services api-keys update KEY_ID \
    --project="PROJECT_ID" \
    --append \
    --api-target=service=directions-backend.googleapis.com \
    --allowed-ips="IP_ADDRESS"

Więcej informacji o pakiecie SDK Google Cloud, instalacji pakietu SDK Cloud i tych poleceniach:

Dodawanie klucza interfejsu API do żądania

Do każdego żądania Directions API (starsza wersja) 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/directions/json?origin=Toronto&destination=Montreal&key=YOUR_API_KEY

W przypadku żądań, które używają klucza interfejsu API, musisz używać protokołu HTTPS.