PassKit

PassKit ermöglicht es Ihnen, Ihre mobile Reichweite zu erweitern, indem Sie Apple Wallet und Google Pay Pässe in das Kundenerlebnis integrieren. Erstellen, verwalten, verteilen und analysieren Sie ganz einfach die Performance von digitalen Coupons, Kundenkarten, Mitgliedskarten, Tickets und vielem mehr – ohne dass Ihre Kund:innen eine weitere App benötigen.

Diese Integration wird von PassKit gepflegt.

Über die Integration

Die Integration von Braze und PassKit ermöglicht es Ihnen, das Engagement Ihrer Online-Kampagnen zu steigern und zu messen, indem Sie sofort angepasste Apple Wallet und Google Pay Pässe bereitstellen. Sie können dann die Nutzung analysieren und Anpassungen in Echtzeit vornehmen, um die Besucherzahlen im Shop zu erhöhen, indem Sie standortbezogene Nachrichten und personalisierte, dynamische Updates für die mobile Wallet Ihrer Kund:innen triggern.

Voraussetzungen

Integration

Um die Erfahrungen Ihrer Kund:innen mit der mobilen Wallet weiter zu verbessern, können Sie von Ihrem PassKit-Dashboard aus Daten über den Braze /users/track-Endpunkt an Braze weitergeben.

Beispiele für Daten, die Sie von PassKit weitergeben können:

• Pass erstellt: wenn ein:e Kund:in auf einen Pass-Link klickt und zum ersten Mal einen Pass angezeigt bekommt.
• Pass-Installationen: wenn der/die Kund:in den Pass in seine/ihre Wallet-App einfügt und speichert.
• Pass-Updates: wenn ein Pass aktualisiert wird.
• Pass löschen: wenn ein:e Kund:in den Pass aus seiner/ihrer Wallet-App löscht.

Sobald die Daten an Braze übergeben wurden, können Sie Zielgruppen aufbauen, Inhalte über Liquid personalisieren und Campaigns oder Canvases triggern, nachdem diese Aktionen durchgeführt wurden.

PassKit mit Braze verbinden

Um Daten von PassKit zu übergeben, stellen Sie sicher, dass Sie Ihre externe ID von Braze als PassKits externalId eingestellt haben.

1. Klicken Sie in den Settings unter Integrations in Ihrem PassKit-Pass-Projekt oder -Programm auf Connect unter dem Tab Braze.
   
   
   
2. Geben Sie Ihren Braze-API-Schlüssel und die Endpunkt-URL ein und vergeben Sie einen Namen für Ihren Konnektor.
   
   
3. Schalten Sie Enable Integration und die gewünschten Events um, die Sie in Braze zum Triggern oder Personalisieren Ihrer Nachrichten verwenden möchten.
   

Pass über einen SmartPass-Link erstellen

Innerhalb von Braze können Sie einen SmartPass-Link einrichten, um eine eindeutige URL für Ihre Kund:innen zu generieren, damit sie ihren Pass entweder auf Android oder iOS installieren können. Dazu müssen Sie eine verschlüsselte SmartPass-Daten-Nutzlast definieren, die von einem Braze Content-Block aufgerufen werden kann. Dieser Content-Block kann dann für zukünftige Pässe und Coupons wiederverwendet werden. Folgendes wird während Ihrer Integration verwendet:

• PassKit-URL: Ihre PassKit-URL ist eine eindeutige URL für Ihr PassKit-Programm.
  Jedes Programm hat eine eindeutige URL, die Sie auf dem Tab Distribution Ihres PassKit-Programms oder -Projekts finden. (zum Beispiel https://pub1.pskt.io/c/ww0jir)
  
  
• PassKit-Geheimnis: Neben der URL müssen Sie auch den PassKit-Key für dieses Programm bereithalten.
  Diesen finden Sie auf der gleichen Seite wie Ihre PassKit-URL.
  
  
• Programm- (oder Projekt-)ID: Ihre PassKit-Programm-ID ist erforderlich, um die SmartPass-URL zu erstellen.
  Sie finden sie unter dem Tab Settings Ihres Projekts oder Programms.

Weitere Informationen zur Erstellung verschlüsselter SmartPass-Links finden Sie in diesem PassKit-Artikel.

1. Schritt: Definieren Sie die Nutzdaten Ihres Passes

Zunächst müssen Sie die Nutzlast des Coupons oder Mitglieds definieren.

Es gibt viele verschiedene Komponenten, die Sie in Ihre Nutzlast aufnehmen können, aber hier sind zwei wichtige zu nennen:

Eine vollständige Liste der verfügbaren Felder, ihrer Typen und hilfreichen Beschreibungen finden Sie in der PassKit-GitHub-Dokumentation.

Beispiel-Nutzlast

1
2
3
4
5
6
7
8
{
  "members.member.externalId": "{{${user_id}}}",
  "members.member.points": "100",
  "members.tier.name": "current_customer",
  "person.displayName": "{{${first_name}}} {{${last_name}}}",
  "person.externalId": "{{${user_id}}}",
  "universal.expiryDate": "{{ "now" | date: "%s" | plus: 31622400 | date: "%FT%TZ" }}"
}

2. Schritt: Erstellen und kodieren Sie eine undefinierte Nutzlastvariable

Erstellen und benennen Sie einen neuen Content-Block, indem Sie im Braze-Dashboard zu Content > Content Block navigieren.

Wählen Sie Create Content Block, um loszulegen.

Als Nächstes müssen Sie Ihren Content Block Liquid Tag definieren. Nachdem Sie diesen Content-Block gespeichert haben, können Sie beim Verfassen von Nachrichten auf diesen Liquid-Tag verweisen. In diesem Beispiel haben wir den Liquid-Tag als {{content_blocks.${passKit_SmartPass_url}}} zugewiesen.

Innerhalb dieses Content-Blocks werden wir die Nutzdaten nicht direkt einbinden, sondern in einer {{passData}}-Variablen referenzieren. Das erste Code-Snippet, das Sie zu Ihrem Content-Block hinzufügen müssen, erfasst eine Base64-Kodierung der Variablen {{passData}}.

1
{% capture base64JsonPayload %}{{passDatapassData|base64_encode}}{% endcapture %}

3. Schritt: Erstellen Sie Ihre Verschlüsselungssignatur mit einem SHA1-HMAC-Hash

Als Nächstes erstellen Sie Ihre Verschlüsselungssignatur unter Verwendung eines SHA1-HMAC-Hashes der Projekt-URL und der Nutzdaten.

Das zweite Code-Snippet, das Sie zu Ihrem Content-Block hinzufügen müssen, erfasst die URL, die für das Hashing verwendet werden soll.

1
{% capture url %}{{projectUrl}}?data={{base64JsonPayload}}{% endcapture %}

Als Nächstes müssen Sie mit diesem Hash und Ihrem Project Secret eine Signatur erzeugen. Dazu können Sie ein drittes Code-Snippet einfügen:

1
{% capture sig %}{{url | hmac_sha1: "Project_Secret"}}{% endcapture %}

Schließlich fügen Sie die Signatur mit dem fünften Code-Snippet an die vollständige URL an:

1
{% capture longURL %}{{projectUrl}}?data={{base64JsonPayload}}&sig={{sig}}{% endcapture %}

4. Schritt: Geben Sie Ihre URL aus

Stellen Sie abschließend sicher, dass Sie Ihre endgültige URL aufrufen, damit Ihre SmartPass-URL in Ihrer Nachricht ausgegeben wird.

1
{{longURL}}

Jetzt haben Sie einen Content-Block erstellt, der in etwa so aussieht:

1
2
3
4
5
6
7
8
9
{% capture base64JsonPayload %}{{passData|base64_encode}}{% endcapture %}

{% capture url %}{{projectUrl}}?data={{base64JsonPayload}}{% endcapture %}

{% capture sig %}{{url | hmac_sha1: "Project_Secret"}}{% endcapture %}

{% capture longURL %}{{projectUrl}}?data={{base64JsonPayload}}&sig={{sig}}&utm_source=braze&utm_campaign={{campaign.${name}}}{% endcapture %}{% capture longURL %}{{longURL | url_encode}}{% endcapture %}

{{longURL}}

In diesem Beispiel wurden UTM-Parameter hinzugefügt, um die Quelle dieser Installationen bis zu Braze und dieser Kampagne zurückzuverfolgen.

Tipp

Denken Sie daran, Ihren Content-Block zu speichern, bevor Sie die Seite verlassen.

5. Schritt: Alles zusammenfügen

Sobald dieser Content-Block erstellt wurde, kann er in Zukunft wiederverwendet werden.

Sie werden feststellen, dass im Beispiel-Content-Block zwei Variablen nicht definiert sind.
{{passData}} – Ihre in Schritt 1 definierte JSON-Pass-Daten-Nutzlast
{{projectUrl}} – Die URL Ihres Projekts oder Programms, die Sie auf dem Tab „Distribution“ Ihres PassKit-Projekts finden.

Diese Entscheidung ist zweckmäßig und unterstützt die Wiederverwendbarkeit des Content-Blocks. Da diese Variablen im Content-Block nur referenziert und nicht erstellt werden, können sie sich ändern, ohne den Content-Block neu zu erstellen.

Vielleicht möchten Sie zum Beispiel das Einführungsangebot ändern, um mehr Anfangspunkte in Ihr Kundenbindungs-Programm aufzunehmen, oder Sie möchten eine zweite Mitgliedskarte oder einen Coupon erstellen. Diese Szenarien würden unterschiedliche PassKit-projectURLs oder unterschiedliche Pass-Payloads erfordern, die Sie pro Kampagne in Braze definieren.

Verfassen des Nachrichtentextes

Sie sollten diese beiden Variablen in Ihrem Nachrichtentext erfassen und dann Ihren Content-Block aufrufen. Erfassen Sie Ihre minimierte JSON-Nutzlast aus Schritt 1:

Weisen Sie die Projekt-URL zu

1
{% assign projectUrl = "https://pub1.pskt.io/c/ww0jir" %}

Erfassen Sie das JSON

1
{% capture passData %}{"members.member.externalId": "{{${user_id}}}","members.member.points": "100","members.tier.name": "current_customer","person.displayName": "{{${first_name}}} {{${last_name}}}","person.externalId": "{{${user_id}}}","universal.expiryDate": "{{ "now" | date: "%s" | plus: 31622400 | date: "%FT%TZ" }}"}{% endcapture %}

Referenzieren Sie den Content-Block, den Sie gerade erstellt haben

1
{{content_block.${passkit_SmartPass_url}}}

Ihr Nachrichtentext sollte in etwa so aussehen:

Die Ausgabe-URL für das Beispiel lautet:

Die Ausgabe-URL wird lang sein. Der Grund dafür ist, dass sie alle Pass-Daten enthält und erstklassige Sicherheit bietet, um die Integrität der Daten zu gewährleisten und eine Verfälschung durch URL-Änderungen zu verhindern. Wenn Sie diese URL per SMS verbreiten, sollten Sie sie durch einen Linkverkürzungsprozess wie bit.ly laufen lassen. Dies kann durch einen Connected-Content-Aufruf an einen bit.ly-Endpunkt geschehen.

Pass mit dem PassKit-Webhook aktualisieren

Innerhalb von Braze können Sie eine Webhook-Kampagne oder einen Webhook innerhalb eines Canvas einrichten, um einen bestehenden Pass auf der Grundlage des Verhaltens Ihrer Nutzer:innen zu aktualisieren. Unter den folgenden Links finden Sie Informationen über nützliche PassKit-Endpunkte.

• Mitgliederprojekte
• Coupon-Projekte
• Flugprojekte

Parameter der Nutzlast

Bevor Sie beginnen, finden Sie hier die üblichen JSON-Payload-Parameter, die Sie in Ihre Webhooks zum Erstellen und Aktualisieren von PassKit aufnehmen können.

1. Schritt: Erstellen Sie Ihr Braze-Webhook-Template

Um ein PassKit-Webhook-Template zu erstellen, das Sie in zukünftigen Campaigns oder Canvases verwenden können, navigieren Sie zum Abschnitt Templates & Media im Braze-Dashboard. Wenn Sie eine einmalige PassKit-Webhook-Kampagne erstellen oder ein bestehendes Template verwenden möchten, wählen Sie bei der Erstellung einer neuen Campaign Webhook in Braze aus.

Sobald Sie das PassKit-Webhook-Template ausgewählt haben, sollten Sie Folgendes sehen:

• Webhook URL: https://api-pub1.passkit.io/coupon/singleUse/coupon
• Request Body: Raw Text

Anfrage-Header und Methode

PassKit benötigt zur Autorisierung einen HTTP Header, der Ihren PassKit-API-Schlüssel in Base 64 kodiert enthält. Das Folgende ist bereits als Schlüssel-Wert-Paar im Template enthalten, aber auf dem Tab Settings müssen Sie <PASSKIT_LONG_LIVED_TOKEN> durch Ihr PassKit-Token ersetzen. Um Ihr Token abzurufen, navigieren Sie zu Ihrem PassKit-Projekt/Programm und gehen Sie zu Settings > Integrations > Long Lived Token.

• HTTP-Methode: PUT
• Anfrage-Header:
  • Authorization: Bearer <PASSKIT_LONG_LIVED_TOKEN>
  • Content-Type: application/json

Anfragetext

Um den Webhook einzurichten, füllen Sie die neuen Event-Details im Anfragetext aus, einschließlich der für Ihren Anwendungsfall erforderlichen Nutzlast-Parameter:

1
2
3
4
5
{
  "externalId": "{{${user_id}}}",
  "campaignId": " 2xa1lRy8dBz4eEElBfmIz8",
  "expiryDate": "2020-05-10T00:00:00Z"
}

2. Schritt: Vorschau Ihrer Anfrage

Ihr Rohtext wird automatisch hervorgehoben, wenn es sich um einen passenden Braze-Tag handelt.

Eine Vorschau Ihrer Anfrage finden Sie im Panel Preview oder auf dem Tab Test, wo Sie eine zufällige Nutzer:in, eine bestehende Nutzer:in auswählen oder Ihre eigene anpassen können, um Ihren Webhook zu testen.

Wichtig

Denken Sie daran, Ihr Template zu speichern, bevor Sie die Seite verlassen!
Aktualisierte Webhook-Templates finden Sie in der Liste Gespeicherte Webhook-Templates, wenn Sie eine neue Webhook-Kampagne erstellen.

Pass-Details über Connected-Content abrufen

Sie können nicht nur Pässe erstellen und aktualisieren, sondern auch die Pass-Metadaten Ihrer Nutzer:innen über Braze Connected-Content abrufen, um personalisierte Pass-Details in Ihre Messaging-Kampagnen einzubinden.

PassKit Connected-Content-Aufruf

1
2
3
{% connected_content  https://api-pub1.passkit.io/coupon/singleUse/coupon/externalId/{{${user_id}}} :headers {"Authorization": "Bearer <PASSKIT_LONG_LIVED_TOKEN>","Content-Type": "application/json"} :save passes %}

{{passes.status}}

Liquid-Beispielantworten

• passes redemptiondetails
• passes status

1
2
3
4
5
6
7
8
9
10
11
{
    "redemptionDate": null,
    "redemptionCode": "",
    "lat": 0,
    "lon": 0,
    "alt": 0,
    "redemptionSource": "",
    "redemptionReference": "",
    "transactionReference": "",
    "transactionAmount": 0
}

1
UNREDEEMED