В этом документе перечислены общие термины и понятия, с которыми вам следует ознакомиться при использовании API Google Кошелька.
Проходит
Проходить
Пропуск — это экземпляр объекта Passes, который выдается пользователю для сохранения в его Google Кошельке. API Google Кошелька обеспечивает поддержку ряда распространенных типов пропусков, включая посадочные талоны, билеты на мероприятия, удостоверения личности и многое другое. API Google Кошелька также предоставляет общий тип пропуска, который можно использовать для создания пропусков, которые в противном случае специально не поддерживаются.
В большинстве случаев проход создается с использованием как класса Passes, так и объекта Passes.
Эмитент пропуска
Эмитент пропусков – это организация, которая создает пропуска и выдает их пользователям для сохранения в Google Кошельке. Эмитент пропусков является владельцем пропусков и может создавать, выдавать и обновлять их. Эмитентами пропусков могут быть отдельные разработчики, компании и организации, а также агрегаторы, которые создают и выпускают пропуска от имени других, например компании, специализирующейся на реализации билетов на мероприятия или купонов для розничной торговли.
Проходит класс
Класс пропусков можно рассматривать как общий шаблон, на основе которого создаются проходы. Класс проходов определяет определенные свойства, которые будут включены во все проходы, которые его используют. Эмитент пропуска может создать несколько классов, каждый со своим собственным набором свойств, определяющих такие атрибуты, как стиль и внешний вид, а также дополнительные функции, такие как Smart Tap, а также регистрацию и вход в систему.
В большинстве случаев пропуск создается путем предоставления класса Passes для определения шаблона пропуска и объекта Passes для определения особенностей выдаваемого отдельного пропуска.
Проходит объект
Объект Passes определяет индивидуальный пропуск, который выдается пользователю для сохранения в его Google Кошельке. Объекты Passes часто содержат информацию, специфичную для пользователя. Например, хотя класс Passes может определять, как будет выглядеть пропуск подарочной карты для конкретного магазина, объект Passes предоставит конкретные сведения, такие как баланс или дата истечения срока действия.
Объект Passes должен создаваться для каждого выдаваемого прохода, в отличие от классов Passes, которые могут использоваться во многих экземплярах прохода.
Частные пропуска
Некоторые пропуски, которые вы создаете с помощью API Google Кошелька, могут содержать конфиденциальные данные пользователя. Этим пропускам требуется дополнительная защита, чтобы обеспечить безопасность данных ваших пользователей, и они управляются по-другому в API Google Кошелька с использованием типа общего частного пропуска . Общий частный пропуск следует использовать в тех случаях, когда конфиденциальные данные (как определено в Политике допустимого использования API Google Кошелька ) включены в ваш пропуск и могут подлежать дополнительному контролю конфиденциальности и проверке во время регистрации.
Умный кран
Smart Tap — это собственный протокол связи ближнего радиуса действия Google для передачи данных между мобильным устройством и терминалом NFC. Технология Smart Tap позволяет пользователям активировать карты, сохраненные в их Google Кошельке, поднеся телефон к любому совместимому NFC-терминалу.
Чтобы использовать протокол Smart Tap со своими пропусками, вам необходимо установить отношения с поставщиком терминалов, поддерживающих Smart Tap .
API и SDK
API Google Кошелька
API Google Wallet — это служба Google, которая позволяет создавать и выдавать пользователям пропуска для сохранения в своих Google кошельках. API можно использовать несколькими различными способами, включая REST API Google Кошелька, Android SDK Google Кошелька и консоль Google Кошелька.
REST API Google Кошелька
REST API Google Кошелька — это интерфейс для программного создания пропусков и управления ими путем отправки HTTP-запросов к API Google Кошелька.
Чтобы использовать REST API Google Кошелька, вам также потребуется учетная запись Google Cloud для создания учетной записи службы, которая используется для аутентификации запросов к REST API Google Кошелька.
SDK Google Кошелька для Android
Google Wallet Android SDK предоставляет набор удобных методов для работы с API Google Кошелька в ваших приложениях Android, таких как создание и выдача пропусков.
Добавить в Google Кошелек
Кнопка «Добавить в Google Кошелек»
Кнопка «Добавить в Google Кошелек» – это одобренный Google ресурс для предоставления пропуска пользователю. Когда пользователь нажимает или касается кнопки, должна активироваться ссылка «Добавить в Google Кошелек», чтобы начать процесс добавления выданного пропуска в Google Кошелек пользователя.
Рекомендуется по возможности использовать кнопку «Добавить в Google Кошелек», поскольку это знакомый элемент пользовательского интерфейса, с которым ваши пользователи уже знают, как взаимодействовать.
Ресурсы и рекомендации по использованию кнопки доступны в Руководстве по бренду Google Wallet API .
Ссылка «Добавить в Google Кошелек»
С помощью ссылки «Добавить в Google Кошелек» вы можете выдать пользователю пропуск с помощью обычной гиперссылки. Его можно использовать везде, где есть гиперссылки, например в электронной почте, SMS, на веб-сайтах и в мобильных приложениях.
Ссылки «Добавить в Google Кошелек» создаются путем добавления подписанного JWT к URL-адресу https://pay.google.com/gp/v/save/ .
Счет эмитента
Демонстрационный режим
Когда вы создаете свою учетную запись эмитента, она будет находиться в «Демо-режиме», пока вам не будет одобрен доступ к публикации. В демонстрационном режиме вы можете создавать пропуска, но вы можете выдавать их только пользователям с ролями «Администратор» или «Разработчик» вашей учетной записи эмитента, а также пользователям, которые были добавлены в качестве тестовых учетных записей в консоли Google Кошелька.
В «Демо-режиме» название всех выданных вами пропусков будет автоматически начинаться со слов «ТОЛЬКО ТЕСТ», указывающих на то, что пропуск предназначен только для целей тестирования.
Тестовые аккаунты
Если ваша учетная запись эмитента находится в «Демо-режиме», если вы хотите выдавать пропуска любому пользователю, у которого нет ролей «Администратор» или «Разработчик» для вашей учетной записи, вы должны добавить их в качестве тестовых учетных записей в консоли Google Кошелька. . Пользователи, зарегистрированные в качестве тестовых учетных записей, смогут добавлять выданные вами пропуска в свой Google Кошелек. Это полезно для тестирования ваших пропусков с более широкой аудиторией в «Демо-режиме».
Бизнес-профиль
Чтобы создать учетную запись эмитента для API Google Wallet, вам необходимо настроить бизнес-профиль при регистрации в консоли Google Pay & Wallet. Бизнес-профиль предоставляет Google основную информацию о вашей компании или организации и требует одобрения для доступа к публикации.
Доступ к публикации
Прежде чем вы сможете выдавать пропуска, которые любой пользователь сможет сохранить в своем Google Кошельке, вам необходимо получить разрешение на доступ к публикации. Чтобы получить разрешение на доступ к публикации, вы должны создать хотя бы один класс Passes и иметь полный бизнес-профиль. Эмитенты, которые хотят выдавать пропуска с помощью Google Wallet Android SDK, также должны предоставить отпечаток SHA-1 для своего приложения.
Чтобы запросить доступ к публикации, перейдите в консоль Google Кошелька и нажмите кнопку «Запросить доступ к публикации». Команда Google Кошелька рассмотрит ваш запрос и сообщит вам, как только вам будет предоставлен доступ к публикации.
Аутентификация
Веб-токен JSON (JWT)
Веб-токены JSON — это широко используемый отраслевой стандарт для безопасной передачи информации в виде объекта JSON. При использовании API Google Кошелька вы кодируете данные объекта Passes, который хотите использовать для создания экземпляра пропуска, в формате JWT (произносится как «jot»), а затем отправляете этот JWT в запросе к API Google Кошелька.
JWT обеспечиваются в безопасности путем подписания их общим секретом перед отправкой в API Google Кошелька. Если вы используете REST API Google Кошелька, секретом подписи является ключ вашей учетной записи службы Google Cloud. Если вы используете Google Wallet Android SDK, секретом подписи является отпечаток SHA-1 вашего приложения Android.
Сервисный аккаунт
Учетная запись службы Google Cloud — это особый тип учетной записи, обычно используемый приложением или вычислительной нагрузкой, а не человеком. В случае API Google Кошелька сервисный аккаунт – это то, что вы будете использовать для аутентификации запросов, отправляемых в REST API Google Кошелька.
Учетные записи сервисов создаются в консоли Google Cloud . Чтобы использовать учетную запись службы, вам также необходимо включить API Google Кошелька в облачной консоли, чтобы учетная запись службы могла отправлять запросы к REST API Google Кошелька.
Ключ учетной записи службы
Ключ сервисного аккаунта — это учетные данные, которые вы будете использовать для аутентификации вызовов REST API Google Кошелька. Ключ сервисной учетной записи считается очень конфиденциальным и должен храниться в тайне, поскольку он предоставляет доступ ко многим функциям Pass Issuer вашей учетной записи с помощью REST API Google Кошелька, включая создание классов Passes и объектов Passes.
Отпечаток SHA-1
Отпечаток SHA-1 вашего сертификата подписи приложения Android — это учетные данные, которые вы будете использовать для аутентификации вызовов API Google Кошелька при использовании Google Wallet Android SDK. Отпечаток SHA-1 вашего сертификата создается с помощью Gradle или keytool. Чтобы использовать отпечаток пальца для аутентификации ваших запросов, вам необходимо зарегистрировать его в консоли Google Кошелька.