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

Выберите платформу: Android iOS Веб-служба JavaScript

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

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

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

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

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

Консоль

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

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

  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 необходимо предоставить отпечаток сертификата SHA-1 ключа подписи, который использовался для подписи приложения. Существует два типа сертификатов:

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

Дополнительные сведения о подписании приложений Android и сертификатах см. в руководстве по подписанию приложений .

Инструкции о том, как найти отпечаток сертификата подписи, см. в ссылках ниже:

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

Консоль

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

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

  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. В раскрывающемся списке « Выбор API» выберите либо Places API , либо Places API (новый) , но не оба одновременно. Если API-интерфейс Places отсутствует в списке, его необходимо включить .
  4. Чтобы завершить изменения, нажмите «Сохранить» .

Облачный SDK

Places SDK для Android (новинка)

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

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-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

SDK Адресов для Android

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

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-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

Что дальше

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