В этом документе перечислены основные термины и понятия, которые необходимо знать при работе с Google Wallet API.
билеты;
Пропустить
Карта – это экземпляр объекта карт, который выдается пользователю для сохранения в Google Кошельке. Google Wallet API поддерживает ряд распространенных типов карт, включая посадочные талоны, билеты на мероприятия, удостоверения личности и т. д. Google Wallet API также предоставляет тип "Универсальный пропуск", который можно использовать для создания пропусков, не поддерживаемых другими способами.
В большинстве случаев для создания карты используются и класс, и объект.
Эмитент карты
Эмитент проездных – это организация, которая создает проездные и выпускает их для пользователей, чтобы они могли сохранять их в Google Кошельке. Эмитент карт владеет картами и может создавать, выпускать и обновлять их. Эмитентами карт могут быть отдельные разработчики, компании и организации, а также агрегаторы, которые создают и выпускают карты от имени других лиц, например компании, специализирующиеся на билетах на мероприятия или купонах для розничных продавцов.
Класс Passes
Класс карт можно рассматривать как общий шаблон, на основе которого создаются карты. Класс карт определяет свойства, которые будут включены во все карты, использующие его. Эмитент карт может создать несколько классов, каждый из которых будет иметь свой набор свойств, определяющих такие атрибуты, как стиль и внешний вид, а также дополнительные функции, например Smart Tap, регистрацию и вход в аккаунт.
В большинстве случаев для создания карты нужно предоставить класс Passes, который определяет шаблон карты, и объект Passes, который определяет особенности конкретной выпускаемой карты.
Объект Passes
Объект карты определяет отдельную карту, которая выдается пользователю для сохранения в Google Кошельке. Объекты часто содержат информацию о конкретных пользователях. Например, если класс карты определяет, как будет выглядеть подарочная карта для определенного магазина, то объект карты будет содержать конкретные сведения, такие как баланс или срок действия.
Для каждого выпущенного билета необходимо создать объект билета. Классы билетов можно использовать для нескольких экземпляров билетов.
Частные карты
Некоторые карты, созданные с помощью Google Wallet API, могут содержать конфиденциальные данные пользователей. Для таких карт предусмотрены дополнительные меры защиты, и в Google Wallet API они обрабатываются иначе – как частные карты общего типа. Общая частная карта должна использоваться, если в ней содержатся данные деликатного характера (как определено в правилах допустимого использования Google Wallet API). При интеграции такой карты могут применяться дополнительные настройки конфиденциальности и проверки.
интеллектуальная бесконтактная технология
Smart Tap – это запатентованный протокол связи малого радиуса действия, разработанный Google для передачи данных между мобильным устройством и NFC-терминалом. Интеллектуальная бесконтактная технология позволяет пользователям активировать карты, сохраненные в Google Кошельке, поднося телефон к совместимому NFC-терминалу.
Чтобы использовать протокол Smart Tap для своих карт, вам необходимо установить отношения с поставщиком терминалов с поддержкой Smart Tap.
API и SDK
Google Wallet API
Google Wallet API – это сервис, который позволяет создавать и выпускать карты, чтобы пользователи могли сохранять их в Google Кошельке. API можно использовать по-разному, в том числе через Google Кошелек REST API, Google Кошелек Android SDK и Google Кошелек Console.
Google Wallet REST API
Google Wallet REST API – это интерфейс для программного создания карт и управления ими путем отправки HTTP-запросов к Google Wallet API.
Чтобы использовать Google Wallet REST API, вам также понадобится аккаунт Google Cloud для создания сервисного аккаунта, который используется для аутентификации запросов к Google Wallet REST API.
Google Wallet Android SDK
Android SDK Google Кошелька предоставляет набор удобных методов для работы с Google Wallet API в приложениях 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 Кошелька.
В демонстрационном режиме название каждой выпущенной карты будет начинаться со слов "[TEST ONLY]", чтобы было понятно, что она предназначена только для тестирования.
Тестовые аккаунты
Если аккаунт эмитента находится в деморежиме и вы хотите выпускать карты и билеты для пользователей, у которых нет роли администратора или разработчика, добавьте их в качестве тестовых аккаунтов в консоли Google Кошелька. Пользователи, зарегистрированные в качестве тестовых аккаунтов, смогут добавлять выпущенные вами карты в свой Google Кошелек. Это полезно, если вы хотите протестировать карты на более широкой аудитории в деморежиме.
Профиль компании
Чтобы создать аккаунт эмитента для Google Wallet API, при регистрации в Google Pay & Wallet Console необходимо настроить профиль компании. Профиль компании содержит основную информацию о вашей компании или организации. Чтобы получить доступ к публикации, необходимо одобрение профиля.
Доступ для публикации
Чтобы выпускать карты, которые пользователи смогут сохранять в Google Кошельке, вам нужно получить разрешение на публикацию. Чтобы получить доступ к публикации, вы должны создать хотя бы один класс карт и заполнить профиль компании. Эмитенты, которые хотят выпускать карты с помощью Google Wallet Android SDK, также должны предоставить цифровой отпечаток SHA-1 своего приложения.
Чтобы запросить доступ для публикации, перейдите в консоль Google Кошелька и нажмите кнопку "Запросить доступ для публикации". Команда Google Кошелька рассмотрит ваш запрос и сообщит, когда вам будет предоставлен доступ к публикации.
Аутентификация
JSON Web Token (JWT)
Токены JWT – это широко используемый отраслевой стандарт для безопасной передачи информации в виде объекта JSON. При использовании Google Wallet API вы кодируете сведения об объекте, который хотите использовать для создания экземпляра карты, в формате JWT (произносится как "джота"), а затем отправляете этот JWT в запросе к Google Wallet API.
Чтобы обеспечить безопасность токенов JWT, перед отправкой в Google Wallet API они подписываются секретным ключом. Если вы используете Google Кошелек REST API, секрет подписи – это ключ сервисного аккаунта Google Cloud. Если вы используете Google Кошелек Android SDK, секретом подписи является цифровой отпечаток SHA-1 для вашего приложения Android.
Сервисный аккаунт
Сервисный аккаунт Google Cloud – это аккаунт специального типа, который обычно используется приложением или рабочей нагрузкой, а не человеком. В случае с Google Wallet API сервисный аккаунт используется для аутентификации запросов, отправляемых в Google Wallet REST API.
Сервисные аккаунты создаются в консоли Google Cloud. Чтобы использовать сервисный аккаунт, вам также нужно включить Google Wallet API в Cloud Console, чтобы сервисный аккаунт мог отправлять запросы к Google Wallet REST API.
Ключ сервисного аккаунта
Ключ сервисного аккаунта – это учетные данные, которые вы будете использовать для аутентификации вызовов REST API Google Кошелька. Ключ сервисного аккаунта считается конфиденциальным и должен храниться в тайне, поскольку он предоставляет доступ ко многим функциям эмитента карт в вашем аккаунте с помощью Google Wallet REST API, включая создание классов и объектов карт.
Отпечаток SHA-1
Цифровой отпечаток сертификата SHA-1, используемого для подписи приложения Android, – это учетные данные, которые вы будете использовать для аутентификации вызовов Google Wallet API при работе с Google Wallet Android SDK. Цифровой отпечаток сертификата SHA-1 создается с помощью Gradle или keytool. Чтобы использовать отпечаток пальца для аутентификации запросов, зарегистрируйте его в Google Кошельке.