Использование ключей API

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Выберите платформу: Android iOS JavaScript

В этом разделе описывается, как создать ключ API для Maps SDK для Android, добавить его в свое приложение и защитить приложение, ограничив ключ. Вы должны добавить ключ API в любое приложение, использующее SDK.

Прежде чем вы начнете

Прежде чем вы начнете использовать Maps SDK для Android, вам нужен проект с платежным аккаунтом и включенным Maps SDK для Android. Дополнительные сведения см. в разделе Настройка в Cloud Console .

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

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

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

Приставка

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

    Перейти на страницу учетных данных

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

Облачный SDK

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

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

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

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

Когда вы ограничиваете свой ключ API, вы должны предоставить отпечаток сертификата SHA-1 ключа подписи, который использовался для подписи приложения. Существует два типа сертификатов:

  • Сертификат отладки : используйте этот тип сертификата только с тестируемыми приложениями и другим нерабочим кодом. Не пытайтесь опубликовать приложение, подписанное сертификатом отладки. Инструменты Android SDK автоматически создают этот сертификат при запуске отладочной сборки.
  • Сертификат выпуска . Используйте этот сертификат, когда будете готовы выпустить приложение в магазин приложений. Инструменты Android SDK создают этот сертификат при запуске сборки выпуска.

Дополнительные сведения о цифровых сертификатах см. в руководстве « Подпишите свое приложение ».

Сведения о том, как получить отпечаток сертификата, см. в разделе Аутентификация вашего клиента . Если вместо этого вы используете Play App Signing , вы должны перейти на страницу подписания приложения в Play Console, чтобы получить отпечаток своего сертификата.

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

Приставка

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

    Перейти на страницу учетных данных

  2. Выберите ключ API, для которого вы хотите установить ограничение. Появится страница свойств ключа API.
  3. В разделе Основные ограничения установите следующие ограничения:
    • Ограничения приложения:
      1. Выберите приложения для Android .
      2. Щелкните + Добавить имя пакета и отпечаток пальца .
      3. Введите имя пакета и отпечаток сертификата SHA-1. Например:
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • Ограничения API:
      1. Щелкните Ограничить ключ .
      2. Выберите Maps SDK для Android в раскрывающемся списке « Выбор API ». Если Maps SDK для Android отсутствует в списке, вам необходимо включить его.
  4. Чтобы завершить изменения, нажмите Сохранить .

Облачный SDK

Список существующих ключей.

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

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

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

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

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api_target="maps-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

Что дальше

Теперь, когда у вас есть ключ API, создайте и настройте проект, как описано в разделе Настройка проекта Android Studio .