Что такое google api key
Maps JavaScript API: как получить ключ API или идентификатор клиента
Примечание. Тарифный план Premium платформы Google Карт больше недоступен для регистрации и новых клиентов.
Выбор метода аутентификации
Возможные методы аутентификации запросов к Maps JavaScript API перечислены ниже.
Ниже перечислены инструменты и отчеты, доступные для каждого метода аутентификации.
Аутентификация с помощью ключа API
Как создать ключи API
Ключ API – это уникальный идентификатор, который используется для аутентификации запросов, связанных с вашим проектом. Он нужен для учета использования API и оплаты. С вашим проектом должен быть связан хотя бы один ключ API.
Чтобы создать его, выполните следующие действия:
Перейдите на страницу выбора проекта в Cloud Console. Выберите проект Google Cloud, для которого нужно добавить ключ API, или создайте новый.
Откройте страницу Google Maps Platform > Credentials (Платформа Google Карт > Учетные данные).
Как добавить в приложение ключ API
Каждый запрос к платформе Google Карт должен содержать ключ API. Укажите свой ключ API вместо YOUR_API_KEY в следующем примере:
Протокол HTTPS является обязательным для запросов с ключом API и рекомендуемым для запросов с идентификатором клиента. Используйте его для приложений, содержащих в запросах конфиденциальные данные пользователей, такие как их местоположение.
Настройка ограничений для ключей API
Ограничения повышают безопасность, поскольку с помощью ключа API можно будет отправлять только авторизованные запросы. Мы настоятельно рекомендуем следовать инструкциям по настройке ограничений для ключей API. Дополнительные сведения приводятся в рекомендациях по работе с ключами API.
Чтобы задать ограничение для ключа API, выполните следующие действия:
Откройте страницу Google Maps Platform > Credentials (Платформа Google Карт > Учетные данные).
Примечание. В источниках file:// необходимо использовать специальное представление, которое следует добавить к ограничению, заданному для ключа. Фрагмент file:// необходимо заменить на __file_url__, прежде чем добавить его к ограничению ключа. Например, вместо file:///path/to/ используйте формат __file_url__//path/to/*. После активации источников file:// рекомендуется постоянно следить за статистикой использования, чтобы убедиться, что показатели соответствуют вашим ожиданиям.
Аутентификация с помощью идентификатора клиента
После приобретения лицензии с тарифным планом Premium для платформы Google Карт вы получите приветственное электронное письмо от Google с идентификатором клиента, который позволяет получить доступ к различным отчетам и инструментам, доступным для этого плана.
Все идентификаторы клиента начинаются с префикса gme-. Ниже показан общепринятый формат.
gme-[company] > proj-[number] ([type])
Аутентификацию запросов Maps JavaScript API можно выполнять с помощью идентификатора клиента и авторизованных URL (вместо ключа API).
Примечание. Этот идентификатор клиента не является ключом и может использоваться только вместе с авторизованными URL. Подробнее о том, как зарегистрировать авторизованные URL…
Как указать идентификатор клиента при загрузке API
Ниже показан пример кода для загрузки Maps JavaScript API. Вместо YOUR_CLIENT_ID введите свой идентификатор клиента.
Примечание. Если ранее для аутентификации у вас был ключ API и теперь вы планируете использовать идентификатор клиента, удалите параметр key перед загрузкой API. Если одновременно используются ключ API и идентификатор клиента, то API не загрузится.
Как зарегистрировать авторизованные URL
Чтобы не допустить применение вашего идентификатора клиента третьими лицами на своих сайтах, его использование необходимо ограничить, указав список авторизованных URL.
Для этого выполните следующие действия.
За один раз можно добавить до 100 URL. Идентификатор клиента может быть связан более чем с 3000 авторизованных URL. Если на Google Картах в вашем приложении будет доступно более 3000 местоположений, мы рекомендуем использовать ключи API вместо URL.
В отношении авторизованных URL следует учитывать следующие факторы:
Все приведенные выше правила применяются ко всем адресам, поэтому важно заранее продумать, какие URL вы будете авторизовывать. Например, если вы авторизуете все вложенные пути указанного пути и все субдомены, в результате могут быть авторизованы страницы, для которых вы не планировали это делать. Пример:
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Using API Keys
This guide shows how to create, restrict, and use your API Key for Google Maps Platform.
Before you begin
Before you start using the Maps JavaScript API, you need a project with a billing account and the Maps JavaScript API enabled. To learn more, see Set up in Cloud Console.
Creating API keys
The API key is a unique identifier that authenticates requests associated with your project for usage and billing purposes. You must have at least one API key associated with your project.
To create an API key:
Console
Go to the Google Maps Platform > Credentials page.
Cloud SDK
Restricting API keys
Restricting API keys adds security to your application by ensuring only authorized requests are made with your API key. We strongly recommend that you follow the instructions to set restrictions for your API keys. For more information, see API security best practices.
To restrict an API key:
Console
Go to the Google Maps Platform > Credentials page.
Note: file:// referers need a special representation to be added to the key restriction. The «file://» part should be replaced with «__file_url__» before being added to the key restriction. For example, «file:///path/to/» should be formatted as «__file_url__//path/to/*». After enabling file:// referers, it is recommended you regularly check your usage, to make sure it matches your expectations.
Cloud SDK
List existing keys.
Clear existing restrictions on existing key.
Set new restrictions on existing key.
Adding the API key to your request
You must include an API key with every Maps JavaScript API request. In the following example, replace YOUR_API_KEY with your API key.
HTTPS is required for requests that use an API key.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Использование ключей API
В этой статье рассказывается, как создать ключ API для Maps SDK для Android, добавить его в приложение и защитить приложение с помощью ограничений ключа. Вы должны добавлять ключи API во все приложения, в которых используется комплект SDK.
Подготовка
Чтобы начать использовать Maps SDK для Android, вам необходимо создать проект с платежным аккаунтом и включить Maps SDK для Android. Подробнее о процессе настройки в Cloud Console…
Как создать ключи API
Ключ API – это уникальный идентификатор, который используется для аутентификации запросов, связанных с вашим проектом. Он нужен для учета использования API и оплаты. С вашим проектом должен быть связан хотя бы один ключ API.
Чтобы создать его, выполните следующие действия.
Cloud Console
Откройте страницу Google Maps Platform > Credentials (Платформа Google Карт > Учетные данные).
Cloud SDK
Прочитайте статьи о Google Cloud SDK, установке Cloud SDK и следующих командах:
Как добавить в приложение ключ API
Чтобы вам было проще работать, используйте Secrets Gradle Plugin для Android.
Чтобы установить плагин и настроить хранение ключа API, выполните следующие действия:
Как задать ограничения для ключей API
Ограничения повышают безопасность, поскольку с помощью ключа API можно будет отправлять только авторизованные запросы. Мы настоятельно рекомендуем следовать инструкциям по настройке ограничений для ключей API. Дополнительные сведения приводятся в рекомендациях по работе с ключами API.
При настройке ограничений ключа API вам потребуется указать цифровой отпечаток сертификата SHA-1 ключа, который использовался для подписи в приложении. Существует два типа сертификатов.
Дополнительную информацию о цифровых сертификатах вы найдете в руководстве по добавлению подписи в приложения.
О том, как получить цифровой отпечаток сертификата, можно прочитать в разделе об аутентификации клиентов. Если вы используете функцию подписания приложений в Google Play, вы можете найти цифровой отпечаток сертификата на странице подписания приложений в Play Console.
Чтобы задать ограничение для ключа API, выполните следующие действия:
Консоль
Откройте страницу Google Maps Platform > Credentials (Платформа Google Карт > Учетные данные).
Cloud SDK
Список существующих ключей.
Снятие ограничений с существующего ключа.
Настройка новых ограничений для существующего ключа.
Прочитайте статьи о Google Cloud SDK, установке Cloud SDK и следующих командах:
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Рекомендации по работе с ключами API
Ключи API необходимы для приложений и проектов, в которых используются API и SDK платформы Google Карт. Ниже рассказывается об использовании и защите ключей API, а также об ограничении их действия.
Что такое ключи API
Ключи API – это учетные данные, которые действуют в пределах проекта и выполняют две задачи:
Каждый ключ API связан с определенным проектом. Когда от проекта поступает вызов, ключ API выступает идентификатором. Благодаря этому информация об использовании регистрируется именно для этого проекта, а вызовы от других проектов отклоняются.
Защита ключей API
Обеспечьте защиту ключей API для всех сервисов платформы Google Карт, которые используются в вашем приложении. Для этого ограничьте действие ключей и воспользуйтесь рекомендациями для используемых API платформы Google Карт. Если незащищенные учетные данные окажутся в общем доступе, ими могут воспользоваться посторонние лица, а платить придется вам.
Ниже приведены стратегии защиты ключей API. Рекомендации для отдельных сервисов платформы Google Карт (Maps JavaScript API и т. д.) читайте в разделе Ключи API: ограничения и рекомендации.
Ограничивайте действие ключей API. Лучший способ защитить ключи API – ограничить их действие конкретными IP-адресами, URL перехода или мобильными приложениями, а также использовать каждый ключ только для определенных API. Эти меры помогают избежать серьезных последствий взлома ключа.
Ограничения ключа можно настроить на консоли. Для этого откройте страницу «Учетные данные» и создайте ключ API с нужной конфигурацией или отредактируйте параметры существующего ключа. Подробнее…
Чтобы удалить ключ API, выполните следующие действия:
Будьте внимательны при создании новых ключей API. Старые ключи уничтожаются через 24 часа после создания новых. Если для перевода приложений со старых ключей на новые требуется более 24 часов, то экземпляры, в которых не успеет обновиться ссылка на ключ, перестанут работать.
При создании нового ключа API происходит следующее:
Следите за отклонениями в использовании API. Если вы заметите признаки несанкционированного использования, смените ключи и сообщите в Google.
Перед сменой старых ключей сохраните настройки ограничений в отдельном файле.
Если в приложении используются Maps Web Service API или Static Web API, вам подойдут следующие методы защиты ключей и приложения.
Если в мобильном приложении используются Web Service API или Static Web API, вам подойдут следующие методы дополнительной защиты ключей и секретов для подписания.
Используйте прокси-сервер. Это сервер-посредник, который обеспечивает безопасное взаимодействие с API платформы Google Карт. Подробнее…
Настройка ограничений для ключей API
Ключи API – тоже учетные данные, поэтому будьте с ними очень осторожны. Обязательно настройте для них ограничения, чтобы избежать серьезных последствий в случае взлома, и выполняйте рекомендации ниже: они помогут обезопасить ваши ключи API.
Ключи можно ограничивать по приложениям и по API.
Ограничение Допустимый тип приложений позволяет использовать ключи API только для определенных сайтов (IP-адресов, URL) или платформ (Android, iOS). Для каждого ключа можно настроить только одно ограничение из этой категории (см. статью об API Google Карт для разных платформ).
Допустимые API позволяют использовать ключи только для конкретных API или SDK платформы Google Карт. Если настроить для ключа такие ограничения, то запросы на использование выбранных API или SDK будут обрабатываться, а для остальных API и SDK – завершаться ошибкой. Для каждого ключа можно настроить любое количество допустимых API. Но если используется ограничение «Допустимый тип приложений», проверьте, чтобы выбранные API и/или SDK его поддерживали.
Как настроить для ключа API допустимый тип приложений
Запросы принимаются только от указанных сайтов.
Запросы принимаются только от указанных IP-адресов веб-серверов.
Задайте под списком типов один адрес (IPv4, IPv6) или подсеть в формате бесклассовой адресации (например, 192.168.0.0/22). Когда вы закончите, появится поле ввода нового адреса. Так вы сможете добавить все нужные адреса.
Чтобы ключ можно было использовать только с вашим приложением для Android, задайте название пакета и цифровой отпечаток сертификата для подписи SHA-1.
Добавьте под списком типов цифровой отпечаток сертификата SHA-1 и название пакета Android из файла AndroidManifest.xml.
Запросы принимаются только от приложения для iOS с указанным идентификатором пакета.
Выберите под списком типов нужный идентификатор пакета iOS.
Как настроить для ключа допустимые API
Ключи API: ограничения и рекомендации
В таблицах ниже приведены ограничения и рекомендации для каждого API, SDK и сервиса платформы Google Карт.
Сайты с Maps JavaScript API, Embed API и Static API
Приложения и серверы, использующие веб-сервисы
Приложения для Android
Приложения для iOS
1 Чтобы использовать ключ API с любыми SDK или API платформы Google Карт, не обязательно настраивать для него ограничения. Но мы настоятельно рекомендуем это сделать, особенно если:
2 Для мобильных приложений рекомендуем использовать нативные пакеты Maps SDK для Android и Maps SDK для iOS.
3 Для Maps Static API и Street View Static API требуется задать не только ключ API, но и цифровую подпись, чтобы можно было превышать квоту в 25 000 загрузок карты в день.
Примечание. Общие секреты для подписания должны иметь не меньший уровень защиты, чем ключи API, использующиеся с Maps Web Service API.
Когда вам требуется динамически подписывать запросы изображений, делайте это на стороне сервера. А если ваши приложения генерируют статические изображения на основе клиентских данных, используйте следующие меры безопасности:
Если вы подписываете запросы, настройте дневную квоту неподписанных запросов.
4 Ограничение по IP-адресам не всегда полезно. Например, его не стоит настраивать для мобильных приложений и облачных сред, работающих на основе динамических IP-адресов. В этих случаях используйте для приложений с Maps Web Service API следующие меры безопасности:
5 Для мобильных приложений рекомендуем использовать нативные пакеты Places SDK для Android и Places SDK для iOS.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Using API Keys
This guide shows how to create, restrict, and use your API key for Google Maps Platform.
Before you begin
Before you start using the Geocoding API, you need a project with a billing account and the Geocoding API enabled. To learn more, see Set up in Cloud Console.
Creating API keys
The API key is a unique identifier that authenticates requests associated with your project for usage and billing purposes. You must have at least one API key associated with your project.
To create an API key:
Console
Go to the Google Maps Platform > Credentials page.
Cloud SDK
Restricting API keys
Restricting API keys adds security to your application by ensuring only authorized requests are made with your API key. We strongly recommend that you follow the instructions to set restrictions for your API keys. For more information, see API security best practices.
To restrict an API key:
Console
Go to the Google Maps Platform > Credentials page.
Cloud SDK
List existing keys.
Clear existing restrictions on existing key.
Set new restrictions on existing key.
Adding the API key to your request
You must include an API key with every Geocoding API request. In the following example, replace YOUR_API_KEY with your API key.
HTTPS is required for requests that use an API key.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.