Tutorials

Todo

Update for 2.0

We prepared four tutorials to get you started with the Google Wallet API.

Before starting, follow the installation and configuration instructions.

Create a pass and load it into the Google Wallet

In this tutorial you will

• create a Wallet Class (a template),

• a Wallet Object (the pass) based on the Wallet Class and

• create a save link to download the pass to the Google Wallet form your mobile device.

We start with a simple example, a generic pass with a title and a header.

At first we create the most simple Wallet Class.

from edutap.wallet_google import api

import os

# if you run the code more than once, you need to change the ID of the class,
# like by incrementing the number part.
class_id = f"{os.environ.get('EDUTAP_WALLET_GOOGLE_ISSUER_ID')}.example_class01.edutap_example"

new_class = api.create(
    "GenericClass",
    {
        "id": class_id,
    },
)

Now we create a simple Wallet Object based on the freshly created class.

# if you run the code more than once, you need to change the ID of the object
object_id = f"{os.environ.get('EDUTAP_WALLET_GOOGLE_ISSUER_ID')}.example_object01.edutap_example"

new_object = api.create(
    "GenericObject",
    {
        "id": object_id,
        "classId": class_id",
        "cardTitle": {
            "defaultValue": {
                "language": "en",
                "value": "Edutap Example Pass 01"
            },
            "translatedValues": []
        },
        "header": {
            "defaultValue": {
                "language": "en",
                "value": "This is an example pass from the edutap tutorial."
            },
            "translatedValues": []
        },
        "state": "ACTIVE"
    },
)

Now the pass is ready for download. To create a link to download the pass, we need to provide the ID of the pass and the origin of the download.

print(
    api.save_link(
        {"genericObjects": [{"id": object_id}]},
        origins=["www.example.com"],
    )
)

This prints a link, which can be opened on a mobile device to download the pass to the Google Wallet. It can be opened in the desktop browser too, given you are logged in with the same Google account as on your mobile device.

Update a class

Todo

Document the update process for a class

Update a pass

Todo

Document the update process for a pass

Send a notification to a pass

Todo

Document the notifucation process for a class

Disable a pass

Todo

Document how to disable passes

List passes

Todo

Document how to list passes