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

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

Подготовка

Чтобы начать использовать Maps SDK для Android, вам необходимо создать проект с платежным аккаунтом и включить Maps SDK для Android. Инструкции вы можете найти в статье Как настроить проект Google Cloud.

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

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

Чтобы создать его, выполните следующие действия:

Cloud Console

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

   Перейти к настройкам учетных данных

2. На странице Credentials (Учетные данные) нажмите Create credentials > API key (Создать учетные данные > Ключ API).
   Появится диалоговое окно с созданным ключом API.
3. Нажмите Close (Закрыть).
   Новый ключ API можно будет найти на странице Credentials (Учетные данные) в разделе API keys (Ключи API).
   Не забудьте настроить ограничения для ключа API, прежде чем использовать его в рабочей среде.

Cloud SDK

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

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

• gcloud alpha services api-keys create

Примечание. Для приложений Maps SDK для Android и Places SDK для Android можно использовать один и тот же ключ API.

Настройка ограничений для ключей API

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

Ограничения, которые вы задаете специально для приложений в Cloud Console, переопределяют настройки в разделе API restrictions (Допустимые API). Поэтому мы советуем придерживаться рекомендаций и создавать отдельные ключи API для каждого приложения и каждой платформы, на которой это приложение будет доступно.

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

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

Узнать об этом больше можно из руководства по добавлению подписи в приложения.

О том, как найти цифровой отпечаток сертификата для подписи, можно узнать по ссылкам ниже:

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

Чтобы задать ограничение для ключа API, выполните указанные ниже действия.

Cloud Console

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

   Перейти к настройкам учетных данных

2. Выберите нужный ключ API. Откроется страница со свойствами ключа API.
3. В разделе Key restrictions (Ограничения для ключа) установите следующие ограничения:
• Ограничения для приложений:
1. Выберите Android apps (Приложения для Android).
2. Заполните поля Package name (Название пакета) и SHA-1 certificate fingerprint (Цифровой отпечаток сертификата SHA-1).
3. Значения должны соответствовать требуемому формату. Пример:

   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. Нажмите Restrict key (Применить ограничения для ключа).
2. В раскрывающемся списке Select APIs (Выберите API) нажмите Maps SDK for Android (Maps SDK для Android). Если Maps SDK для Android там нет, его необходимо включить.
4. Нажмите Save (Сохранить).
   

Cloud 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 и следующих командах:

• gcloud alpha services api-keys update
• gcloud alpha services api-keys lookup
• gcloud services api-keys list

Что дальше

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