Używanie kluczy interfejsu API z interfejsem Address Validation API

Usługi Google Maps Platform zabezpieczają przed nieautoryzowanym użyciem. Ograniczaj wywołania interfejsu API do tych, które podają prawidłowe dane uwierzytelniające. Te dane logowania mają postać klucza interfejsu API – unikalnego ciągu znaków alfanumerycznych, który wiąże Twoje konto rozliczeniowe Google z projektem oraz konkretnym interfejsem API lub pakietem SDK.

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

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.

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 listy adresów IP serwera WWW, wybierz Adresy IP (serwery WWW, zadania cron itp.) na liście Ograniczenia aplikacji. Podaj co najmniej 1 adres IPv4 lub IPv6 albo podsieć w notacji CIDR. Adresy IP muszą odpowiadać adresowi źródłowemu obserwowanemu przez serwery Google Maps Platform. Jeśli używasz tłumaczenia adresów sieciowych (NAT), zwykle odpowiada ono publicznemu adresowi IP Twojego komputera.
    • Ograniczenia interfejsów API:
      1. Kliknij Ogranicz klucz.
      2. Wybierz Address Validation API z menu Wybierz interfejsy API. Jeśli interfejs Address Validation API nie jest widoczny na liście, 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="addressvalidation.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

Dodawanie klucza interfejsu API do żądania

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

https://addressvalidation.googleapis.com/v1:validateAddress?key=YOUR_API_KEY

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