Ten dokument zawiera listę typowych terminologii i zagadnień, które należy znać podczas korzystania z interfejsu API Portfela Google.
Podania
Powodzenie
Karta to wystąpienie obiektu karty wydawanego użytkownikowi w celu zapisania go w jego Portfelu Google. Interfejs Google Wallet API obsługuje wiele popularnych typów kart, w tym karty pokładowe, bilety na wydarzenia i dowody tożsamości. Google Wallet API udostępnia też ogólny typ karty, którego można używać do tworzenia kart, które nie są obsługiwane inaczej.
W większości przypadków karta jest tworzona przy użyciu klasy kart i obiektu kart.
Wystawca karty
Wystawca karty to podmiot, który tworzy karty i wydaje je użytkownikom, aby zapisywali je w Portfelu Google. Wydawca karty jest właścicielem kart i może je tworzyć, wydawać i aktualizować. Wystawcami kart mogą być indywidualni deweloperzy, firmy i organizacje, a także pośrednicy, którzy tworzą i wydają karty w imieniu innych osób, np. firmy specjalizujące się w wdrażaniu biletów na wydarzenia lub kuponów dla sprzedawców.
Klasa kart
Klasa kart można określić jako udostępniony szablon, na podstawie którego tworzone są karty. Klasa kart definiuje określone właściwości, które będą uwzględniane we wszystkich kartach, które z niej korzystają. Wystawca karty może utworzyć wiele klas, każdą z osobnym zestawem właściwości definiujących atrybuty, takich jak styl i wygląd, a także dodatkowe funkcje, takie jak smart tap czy rejestracja i logowanie.
W większości przypadków karta jest tworzona przez podanie klasy kart do zdefiniowania szablonu karty i obiektu kart do zdefiniowania specyfiki wystawianej karty.
Obiekt kart
Obiekt karty określa pojedynczą kartę, która jest wydawana użytkownikowi, aby zapisać ją w jego Portfelu Google. Obiekty kart często zawierają informacje dotyczące użytkownika. Na przykład klasa kart może określać wygląd karty podarunkowej z konkretnego sklepu, ale obiekt Karty udostępnia szczegółowe informacje, takie jak saldo lub data ważności.
Dla każdej wystawionej karty należy utworzyć obiekt karty – w przeciwieństwie do klas kart, które można udostępniać w wielu instancjach kart.
dokumenty prywatne.
Niektóre karty utworzone przez Ciebie za pomocą Google Wallet API mogą zawierać poufne dane użytkownika. Dokumenty te wymagają dodatkowej ochrony, aby zapewnić bezpieczeństwo danych użytkowników. Można też nimi zarządzać w interfejsie Google Wallet API w inny sposób przy użyciu typu Ogólnego dokumentu prywatnego. Ogólnej dokumentu prywatnego należy używać, gdy karta zawiera dane wrażliwe (zgodnie z definicją w Zasadach dopuszczalnego użytkowania interfejsu API Portfela Google). Mogą one podlegać dodatkowym ustawieniom prywatności oraz zostać sprawdzone podczas rejestracji.
Smart tap
Smart Tap to zastrzeżony przez Google protokół komunikacji Near Field Communication Protocol do przesyłania danych między urządzeniem mobilnym a terminalem NFC. Technologia smart tap pozwala użytkownikom wykorzystywać karty zapisane w Portfelu Google przez zbliżenie telefonu do zgodnego terminala NFC.
Aby korzystać z protokołu smart tap w przypadku kart, musisz nawiązać relację z dostawcą terminala obsługującego smart tap.
Interfejsy API i pakiet SDK
Google Wallet API
Google Wallet API to usługa świadczona przez Google, która pozwala tworzyć i wystawiać karty, które użytkownicy mogą zapisywać w swoich Portfelu Google. Interfejsu API można używać na kilka różnych sposobów, np. za pomocą interfejsu API Portfela Google typu REST, pakietu SDK Portfela Google na Androida i konsoli Portfela Google.
Interfejs API Portfela Google typu REST
Interfejs API Portfela Google typu REST to interfejs do automatycznego tworzenia kart i zarządzania nimi przez wysyłanie żądań HTTP do API Portfela Google.
Aby korzystać z interfejsu API typu REST Portfela Google, potrzebujesz też konta Google Cloud i utwórz konto usługi, które będzie służyć do uwierzytelniania żądań wysyłanych do interfejsu API REST Portfela Google.
Pakiet SDK Portfela Google na Androida
Pakiet SDK Portfela Google na Androida zapewnia zestaw wygodnych metod pracy z interfejsem API Portfela Google w aplikacjach na Androida, takich jak tworzenie i wydawanie kart.
Dodaj do Portfela Google
Przycisk „Dodaj do Portfela Google”
Przycisk „Dodaj do Portfela Google” to zatwierdzony przez Google zasób służący do okazania karty użytkownikowi. Gdy użytkownik kliknie ten przycisk, powinien się uruchomić link „Dodaj do Portfela Google”, który rozpocznie proces dodawania wydanej karty do jego Portfela Google.
Zalecamy używanie przycisku „Dodaj do Portfela Google” w miarę możliwości, ponieważ jest to znany element interfejsu, z którego użytkownicy już wiedzą, jak z niego korzystać.
Zasoby i wytyczne dotyczące używania tego przycisku są dostępne we wskazówkach dotyczących interfejsu API Portfela Google.
Link „Dodaj do Portfela Google”
Dzięki linkowi „Dodaj do Portfela Google” możesz wydać użytkownikowi kartę, używając zwykłego hiperlinku. Możesz ich używać wszędzie tam, gdzie możesz korzystać z hiperlinków, np. w e-mailach, SMS-ach, na stronach internetowych lub w aplikacjach mobilnych.
Linki „Dodaj do Portfela Google” tworzy się przez dołączenie podpisanego tokena JWT do adresu URL https://pay.google.com/gp/v/save/.
Konto wydawcy
Tryb demonstracyjny
Gdy utworzysz konto wydawcy, będzie ono działać w trybie demonstracyjnym, dopóki nie otrzymasz zgody na publikowanie. W trybie demonstracyjnym możesz tworzyć karty, ale przyznawać je tylko użytkownikom z przypisaną rolą administratora lub programisty na Twoim koncie wystawcy albo użytkownikom, którzy zostali dodani jako konta testowe w konsoli Portfela Google.
W „Trybie demonstracyjnym” tytuły wystawionych przez Ciebie kart automatycznie zaczynają się od słowa „[TYLKO DO TESTÓW]”, aby wskazać, że karnet służy tylko do testów.
Konta testowe
Jeśli Twoje konto wystawcy działa w „trybie demonstracyjnym” i chcesz przyznawać karty użytkownikom, którzy nie mają na tym koncie ról administratora ani programisty, musisz dodać te konta jako konta testowe w konsoli Portfela Google. Użytkownicy z kontami testowymi będą mogli dodawać do Portfela Google karty wydane przez Ciebie. Przydaje się to do testowania kart na szerszej grupie odbiorców w trybie demonstracyjnym.
Profil firmy
Aby utworzyć konto wystawcy dla interfejsu Google Wallet API, podczas rejestracji w konsoli usług Google Pay i Portfela Google musisz skonfigurować profil firmy. Profil firmy dostarcza Google podstawowe informacje o Twojej firmie lub organizacji i musi uzyskać dostęp do publikowania.
Dostęp do publikowania
Zanim zaczniesz wydawać karty, które każdy użytkownik może zapisywać w swoim Portfelu Google, musisz mieć pozwolenie na publikowanie. Aby uzyskać dostęp do publikowania, musisz utworzyć co najmniej 1 klasę kart i mieć kompletny profil firmy. Wystawcy, którzy chcą wystawiać karty za pomocą pakietu SDK Portfela Google na Androida, muszą też przesłać odcisk cyfrowy SHA-1 swojej aplikacji.
Aby poprosić o dostęp do publikowania, otwórz konsolę Portfela Google i kliknij przycisk „Poproś o dostęp do publikacji”. Zespół Portfela Google rozpatrzy Twoją prośbę i powiadomi Cię, gdy przyznasz dostęp do publikowania.
Uwierzytelnianie
Token internetowy JSON (JWT)
Tokeny sieciowe JSON to powszechnie stosowany standard branżowy do bezpiecznego przesyłania informacji w postaci obiektu JSON. Jeśli korzystasz z interfejsu Google Wallet API, kodujesz szczegóły obiektu Karty, których chcesz użyć do utworzenia instancji karty, w formacie JWT (czytelnym wyrazem „jot”), a następnie wysyłasz go w żądaniu do interfejsu Google Wallet API.
Tokeny JWT są chronione przed wysłaniem do Google Wallet API, podpisując je wspólnym tajnym kluczem. Jeśli używasz interfejsu API Portfela Google typu REST, tajny klucz podpisywania to klucz konta usługi Google Cloud. Jeśli używasz pakietu SDK Portfela Google na Androida, tajnym kluczem podpisywania jest odcisk cyfrowy SHA-1 Twojej aplikacji na Androida.
Konto usługi
Konto usługi Google Cloud to specjalne konto, zwykle używane przez aplikację lub zadanie obliczeniowe, a nie przez osobę. W przypadku interfejsu API Portfela Google konto usługi będzie służyć do uwierzytelniania żądań wysyłanych do interfejsu API typu REST Portfela Google.
Konta usługi tworzy się w konsoli Google Cloud. Aby korzystać z konta usługi, musisz też włączyć interfejs Google Wallet API w konsoli Cloud, aby umożliwić kontu usługi wysyłanie żądań do interfejsu API Portfela Google typu REST.
Klucz konta usługi
Klucz konta usługi to dane logowania, których będziesz używać do uwierzytelniania wywołań interfejsu API typu REST Portfela Google. Klucz konta usługi jest uważany za bardzo wrażliwy i należy go przechowywać jako prywatny, ponieważ umożliwia on dostęp do wielu funkcji wydawcy kart na Twoim koncie za pomocą interfejsu API REST Portfela Google, w tym do tworzenia klas kart i obiektów kart.
Odcisk cyfrowy SHA-1
Odcisk cyfrowy SHA-1 certyfikatu podpisywania aplikacji na Androida to dane logowania, których będziesz używać do uwierzytelniania wywołań interfejsu API Portfela Google podczas korzystania z pakietu SDK Portfela Google na Androida. Odcisk cyfrowy SHA-1 certyfikatu jest generowany przy użyciu narzędzia Gradle lub narzędzia Keytool. Aby uwierzytelniać żądania za pomocą odcisku cyfrowego, musisz zarejestrować go w konsoli Portfela Google.