Как настроить Maps Static API

В этом документе описаны шаги, которые необходимо выполнить, чтобы начать работу с Maps Static API.

Требования

В этом разделе рассказывается, как настроить аккаунт Google Cloud и облачный проект с включенными платежными функциями. Также необходимо знать, как взимается плата за использование Maps Static API.

  1. Изучите информацию о выставлении счетов и стоимости использования в статье Использование Maps Static API и оплата.

  2. Убедитесь, что у вас есть аккаунт Google Cloud.

    Войдите в консоль Google Cloud.

  3. Убедитесь, что у вас есть проект Google Cloud с включенными платежными функциями.

    Перейти на страницу "Оплата"
    1. Выберите проект, чтобы открыть страницу Billing (Оплата).

    2. На странице Оплата:

      • Если для выбранного проекта уже включена оплата и у вас только один платежный аккаунт, откроется страница Оплата.
      • Если у вас несколько платежных аккаунтов, нажмите Открыть этот аккаунт. Появится страница с информацией о платежном аккаунте, связанном с проектом.
      • Если у вас есть платежный аккаунт, но он не связан с проектом, вам будет предложено связать их.
      • Если у вас нет платежного аккаунта или вы хотите создать новый, выберите Manage Billing Accounts (Управление платежными аккаунтами). Подробнее о том, как создать платежный аккаунт Cloud для самостоятельного использования…

Включение API

Прежде чем использовать Maps Static API, необходимо включить его в облачном проекте Google Cloud в консоли Google Cloud или с помощью команды gcloud.

Чтобы включить API, выполните следующие действия:

Консоль

  1. Откройте страницу продукта в консоли Google Cloud:

    Включить Maps Static API

  2. Нажмите Включить.

gcloud

gcloud services enable \
    --project "PROJECT" \
    "static-maps-backend.googleapis.com"

Прочитайте статьи о Google Cloud SDK, установке Cloud SDK и следующих командах:

Получите ключ API для использования с Maps Static API

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

Ключ API – это уникальная буквенно-цифровая строка, которая связывает ваш платежный аккаунт Cloud и облачный проект Google Cloud с запросом, который ваше приложение отправляет в API или SDK платформы Google Карт. Чтобы создать ключ или добавить API или SDK к существующему ключу, следуйте инструкциям ниже.

Консоль

  1. Откройте страницу Google Maps Platform > Keys & Credentials (Платформа Google Карт > Ключи и учетные данные).

    Перейти на страницу "Ключи и учетные данные"

  2. Если появится запрос, выберите проект.

  3. Выполните одно из следующих действий:

    • Создайте ключ.

      1. Нажмите Создать учетные данные > Ключ API.
      2. На панели Create API key (Создать ключ API) откройте список Select API restrictions (Выбрать ограничения API).
      3. Удалите все API, которые не нужны для этого ключа, и убедитесь, что выбран Maps Static API.
      4. Нажмите Создать. На панели появится новый ключ API.

    • Использовать существующий ключ:

      1. Нажмите на название ключа.
      2. В списке Выбрать ограничения API выберите Maps Static API.
      3. Нажмите Сохранить.

    Выбор API не означает его включение. Убедитесь, что Maps Static API включен на странице библиотеки API.

  4. Чтобы посмотреть строку ключа позже, перейдите на страницу Ключи и учетные данные и нажмите Показать ключ.

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

gcloud

В следующих командах замените PROJECT_ID идентификатором своего проекта.

  • Создайте новый ключ. Выполните следующую команду, заменив DISPLAY_NAME на название ключа. 

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

    Прочитайте статьи о Google Cloud SDK, установке Cloud SDK и следующих командах:

  • Использовать существующий ключ. Выполните следующую команду, заменив KEY_ID идентификатором ключа. Флаг --append сохраняет API, которые уже разрешены ключом. Если его не указать, команда заменит их.

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

    Прочитайте статьи о Google Cloud SDK, установке Cloud SDK и следующих командах:

    Идентификатор ключа – это не строка ключа и не отображаемое название. Чтобы найти его, выполните команду gcloud services api-keys list --project="PROJECT_ID". Идентификатор – это последняя часть поля name: projects/PROJECT_NUMBER/locations/global/keys/KEY_ID.

Чтобы посмотреть строку ключа, выполните команду gcloud services api-keys get-key-string KEY_ID --project="PROJECT_ID".

Как отправить запрос к API

Выполните запрос к Maps Static API в браузере, чтобы получить статическую карту. Вы должны включать буквенно-цифровой ключ API в каждый запрос и использовать HTTPS для запросов, содержащих ключ API.

  1. Нажмите API_KEY в URL ниже, чтобы вставить буквенно-цифровую строку ключа:

    https://maps.googleapis.com/maps/api/staticmap?center=Brooklyn+Bridge,New+York,NY&zoom=13&size=600x300&maptype=roadmap&markers=color:blue%7Clabel:S%7C40.702147,-74.015794&markers=color:green%7Clabel:G%7C40.711614,-74.012318&markers=color:red%7Clabel:C%7C40.718217,-73.998284&key=YOUR_API_KEY
  2. Нажмите на значок копирования в примере кода Нажмите на значок копирования., чтобы скопировать URL.
  3. Вставьте URL в адресную строку браузера и откройте ссылку.

Изображение выглядит следующим образом:

Карты центра Нью-Йорка.

Как применить ограничения для ключа API

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

  • Ограничения API определяют, какие SDK и API можно вызывать с помощью ключа API. При создании ключа в консоли или gcloud CLI необходимо задать хотя бы одно ограничение API.
  • Ограничения для приложений определяют, какие сайты, IP-адреса или приложения могут использовать ключ API.

Подробнее о том, как ограничить использование ключей API…

Дальнейшие действия

В зависимости от того, как вы используете запросы, для их аутентификации в дополнение к ключу API может понадобиться цифровая подпись. Подробнее о том, как использовать цифровую подпись…