Używanie kluczy interfejsu API z interfejsem Miejsca API

Usługi Google Maps Platform są chronione przed nieautoryzowanym użyciem przez ograniczenie wywołań interfejsu API do tych, które podają prawidłowe dane uwierzytelniające. Te dane logowania mają postać klucza interfejsu API – unikalnego ciągu alfanumerycznego, który wiąże Twoje konto rozliczeniowe Google z Twoim projektem oraz z konkretnym interfejsem API lub pakietem SDK.

Z tego przewodnika dowiesz się, jak utworzyć klucz interfejsu API, ograniczyć go i używać na potrzeby Google Maps Platform.

Zanim zaczniesz

Zanim zaczniesz korzystać z interfejsu Places API, musisz mieć projekt z kontem rozliczeniowym i włączonym interfejsem Places API. Więcej informacji znajdziesz w artykule Konfiguracja w Cloud Console.

Tworzenie kluczy interfejsu API

Klucz interfejsu API to unikalny identyfikator służący do uwierzytelniania żądań powiązanych z Twoim projektem na potrzeby wykorzystania 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 znajduje się na stronie Dane logowania w sekcji Klucze interfejsu API.
    (Pamiętaj o ograniczeniu dostępu 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 pakiecie SDK Google Cloud, instalacji pakietu SDK Cloud i tych poleceniach:

Ograniczanie kluczy interfejsu API

Google zdecydowanie zaleca ograniczenie kluczy interfejsu API przez ograniczenie ich używania tylko do tych interfejsów API, które są potrzebne aplikacji. Ograniczenie kluczy interfejsu API zwiększa bezpieczeństwo aplikacji przez ochronę przed niechcianymi żądaniami. Więcej informacji znajdziesz w artykule na temat sprawdzonych metod zapewniania bezpieczeństwa interfejsów 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 właściwości klucza interfejsu API.
  3. W sekcji Ograniczenia klucza ustaw te ograniczenia:
    • Ograniczenia aplikacji:
      1. Aby akceptować żądania z podanej listy adresów IP serwerów WWW, wybierz Adresy IP (serwery WWW, zadania cron itp.) na liście Ograniczenia aplikacji. Podaj co najmniej jeden adres IPv4 lub IPv6 albo podsieć w notacji CIDR. Adresy IP muszą być zgodne z adresami źródłowymi obserwowanymi przez serwery Google Maps Platform. Jeśli używasz tłumaczenia adresów sieciowych (NAT), zwykle odpowiada ono publicznemu adresowi IP komputera.
    • Ograniczenia interfejsów API:
      1. Kliknij Ogranicz klucz.
      2. Z menu Wybierz interfejsy API wybierz Places API lub Places API (nowy), ale nie obie te opcje jednocześnie. Jeśli interfejs Places API lub Places API (nowy) nie będą się wyświetlać, musisz go enable.
  4. Aby zastosować zmiany, kliknij Zapisz.

(pakiet) SDK Cloud

Places API (nowość)

Wyświetl listę istniejących kluczy.

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

Usuń obecne ograniczenia 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="places.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

Places API

Wyświetl listę istniejących kluczy.

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

Usuń obecne ograniczenia 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="places-backend.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

Dodawanie klucza interfejsu API do żądania

Do każdego żądania do interfejsu Places API musisz dołączyć klucz interfejsu API. W poniższym przykładzie zastąp YOUR_API_KEY swoim kluczem interfejsu API.

https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&key=YOUR_API_KEY

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