Używanie kluczy interfejsu API z interfejsem Time Zone API

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

Z tego przewodnika dowiesz się, jak utworzyć klucz interfejsu API Google Maps Platform, a także jak go używać i ograniczać.

Zanim zaczniesz

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

Tworzenie kluczy interfejsu API

Klucz interfejsu API jest unikalnym identyfikatorem do uwierzytelniania żądań powiązanych z Twoim projektem na potrzeby płatności i wykorzystania. Z Twoim projektem musi być powiązany co najmniej 1 klucz interfejsu 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świetla 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, aby ograniczyć dostęp do klucza interfejsu API przed jego użyciem w środowisku produkcyjnym).

(pakiet) SDK Cloud

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

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

Ograniczanie kluczy interfejsu API

Zdecydowanie zalecamy ograniczenie kluczy interfejsu API, ograniczając ich wykorzystanie tylko do tych interfejsów API, które są potrzebne w przypadku Twojej aplikacji. Ograniczenie kluczy interfejsu API zapewnia dodatkową ochronę aplikacji przez ochronę przed niechcianymi żądaniami. Więcej informacji znajdziesz w artykule Sprawdzone metody zabezpieczania 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 przesłanych przez Ciebie adresów IP serwera WWW, wybierz z listy Ograniczenia aplikacji Adresy IP (serwery WWW, zadania cron itp.). Podaj co najmniej 1 adres IPv4 lub IPv6 albo podsieć w notacji CIDR. Adresy IP muszą odpowiadać adresom źródłowym obserwowanym przez serwery Google Maps Platform. Jeśli korzystasz z tłumaczenia adresu sieciowego (NAT), zwykle jest to związane z publicznym adresem IP komputera.
    • Ograniczenia interfejsów API:
      1. Kliknij Ogranicz klucz.
      2. Wybierz Time Zone API z menu Select APIs. Jeśli interfejsu Time Zone API nie ma na liście, musisz go włączyć.
  4. Aby zapisać zmiany, kliknij Zapisz.

(pakiet) SDK Cloud

wyświetlić listę istniejących kluczy,

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

Usuń istniejące 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="timezone-backend.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

Dodawanie klucza interfejsu API do żądania

Do każdego żądania do interfejsu Time Zone musisz dołączyć klucz interfejsu API. W przykładzie poniżej zastąp YOUR_API_KEY kluczem interfejsu API.

https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810,-119.6822510&timestamp=1331161200&key=YOUR_API_KEY

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