Используйте ключи API с API мест

Выберите платформу: Android iOS JavaScript Web Service

Продукты платформы Google Maps защищены от несанкционированного использования путем ограничения вызовов API теми, которые предоставляют надлежащие учетные данные аутентификации. Эти учетные данные имеют форму ключа API — уникальной буквенно-цифровой строки, которая связывает ваш платежный аккаунт Google с вашим проектом и с конкретным API или SDK.

В этом руководстве показано, как создать, ограничить и использовать ваш ключ API для платформы Google Карт.

Прежде чем начать

Прежде чем начать использовать API Places, вам нужен проект с платежным аккаунтом и включенным API Places. Чтобы узнать больше, см. Настройка в консоли Cloud .

Создание API-ключей

API-ключ — это уникальный идентификатор, который аутентифицирует запросы, связанные с вашим проектом, для целей использования и выставления счетов. У вас должен быть хотя бы один API-ключ, связанный с вашим проектом.

Чтобы создать ключ API:

Консоль

  1. Перейдите на страницу «Платформа Google Карт» > «Учетные данные» .

    Перейти на страницу «Учетные данные»

  2. На странице «Учетные данные» нажмите «Создать учетные данные» > «Ключ API» .
    В диалоговом окне создания ключа API отображается только что созданный ключ API.
  3. Нажмите Закрыть.
    Новый ключ API указан на странице «Учетные данные» в разделе «Ключи API» .
    (Не забудьте ограничить ключ API перед его использованием в производстве.)

Облачный SDK

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

Узнайте больше о Google Cloud SDK , установке Cloud SDK и следующих командах:

Ограничение ключей API

Google настоятельно рекомендует вам ограничить ваши ключи API, ограничив их использование только теми API, которые необходимы для вашего приложения. Ограничение ключей API повышает безопасность вашего приложения, защищая его от необоснованных запросов. Для получения дополнительной информации см. рекомендации по безопасности API .

Чтобы ограничить ключ API:

Консоль

  1. Перейдите на страницу «Платформа Google Карт» > «Учетные данные» .

    Перейти на страницу «Учетные данные»

  2. Выберите ключ API, на который вы хотите установить ограничение. Появится страница свойств ключа API.
  3. В разделе «Ограничения ключа» установите следующие ограничения:
    • Ограничения по применению:
      1. Чтобы принимать запросы из списка IP-адресов веб-серверов, которые вы предоставляете, выберите IP-адреса (веб-серверов, заданий cron и т. д.) из списка ограничений приложений . Укажите один или несколько адресов IPv4 или IPv6 или подсеть с использованием нотации CIDR. IP-адреса должны соответствовать исходному адресу, который наблюдают серверы платформы Google Карт. Если вы используете преобразование сетевых адресов (NAT) , это обычно соответствует публичному IP-адресу вашего компьютера.
    • Ограничения API:
      1. Нажмите Ограничить ключ .
      2. Выберите Places API (Legacy) или Places API (New) из раскрывающегося списка Select APIs , но не оба. Если Places API (Legacy) или Places API (New) не указаны в списке, вам необходимо включить их.
  4. Чтобы завершить изменения, нажмите «Сохранить» .

Облачный SDK

API мест (новый)

Перечислите существующие ключи.

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

Снимите существующие ограничения для существующего ключа.

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

Установите новые ограничения для существующего ключа.

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

Узнайте больше о Google Cloud SDK , установке Cloud SDK и следующих командах:

API мест (устаревший)

Перечислите существующие ключи.

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

Снимите существующие ограничения для существующего ключа.

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

Установите новые ограничения для существующего ключа.

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

Узнайте больше о Google Cloud SDK , установке Cloud SDK и следующих командах:

Добавление ключа API к вашему запросу

Вы должны включать ключ API в каждый запрос API Places. В следующем примере замените YOUR_API_KEY на свой ключ API.

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

Для запросов, использующих ключ API, требуется HTTPS.