API Anwendungsfälle

Die REST API von Braze bietet eine breite Palette von Endpunkten, die Sie bei der Verwaltung und Optimierung Ihrer Customer-Engagement-Strategie unterstützen. In diesem Artikel werden wir verschiedene Anwendungsfälle für jede Endpunkt-Sammlung untersuchen: Kataloge, E-Mail-Listen und -Adressen, Export, Nachrichten, Einstellungscenter, SMS, Abo-Gruppen, Templates und Nutzerdaten.

In jedem Abschnitt wird ein Szenario mit einer Schritt-für-Schritt-Anleitung, einem Code-Beispiel und dem erwarteten Ergebnis vorgestellt. Am Ende dieses Artikels werden Sie besser verstehen, wie Sie die REST API von Braze nutzen können, um Ihr Customer-Engagement zu verbessern.

Mehrere Artikel aus einem Katalog löschen

Ein neues Jahr begrüßt die Einführung neuer Produkte bei Kitchenerie, einer Einzelhandelsmarke, die sich auf Küchenartikel spezialisiert hat. Im Braze-Dashboard hat Kitchenerie einen Katalog für seine Geschirrkollektion mit dem Namen “Dishware” eingerichtet. Dieses neue Jahr bedeutet auch, dass wir die folgenden Produkte aus unserer Geschirrkollektion entfernen.

• Flaches Biskuit
• Perlenporzellan
• Rosa Schimmer

Um diese Produkte aus seinem Katalog zu entfernen, kann Kitchener den Endpunkt /catalogs/{catalog_name}/items verwenden, um die IDs der Artikel zu übergeben.

Hier ist die Beispielanfrage:

1
2
3
4
5
6
7
8
9
10
curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/dishware/items' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "items": [
    {"id": "plainbisque"},
    {"id": "pearlporcelain"},
    {"id": "pinkshimmer"}
  ]
}'

Nach dem Senden dieser Nutzlast bestätigt die Antwort, dass Braze die drei Kollektionen erfolgreich aus dem Geschirrkatalog von Kitchenerie entfernt hat.

1
2
3
{
  "message": "success"
}

Entfernen von E-Mails aus der Braze Spam-Liste

Bei MovieCanon, einem Unternehmen für Serviceleistungen; Dienste, ist das Entwickler:in Team dafür verantwortlich, die E-Mail-Listen regelmäßig zu überprüfen, um die Nutzer:in zu identifizieren, die für die Kampagnen abonniert sind. Im Rahmen dieser Prüfung möchte MovieCanon diese Liste von E-Mails aus seiner Spam-Liste entfernen:

• august.author.example.com
• [email protected]
• [email protected]
• [email protected]
• [email protected]

Um diese Aufgabe zu erfüllen, benötigt das Entwickler:innen-Team einen API-Schlüssel mit deremail.spam.removeBerechtigung, den/email/spam/removeEndpunkt zu verwenden. Dieser Endpunkt entfernt E-Mail-Adressen aus der Spam-Liste von Braze und der Spam-Liste, die vom E-Mail-Anbieter von MovieCanon geführt wird.

Um diese Anfrage zu senden, geben Sie entweder eine String-E-Mail-Adresse oder ein Array mit bis zu 50 zu ändernden E-Mail-Adressen an. Da die Liste der zu entfernenden E-Mails unter 50 liegt, kann MovieCanon diese Aufgabe mit dem folgenden Anfragetext erledigen:

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
{
  "email": ["august.author.example.com","[email protected]","[email protected]","[email protected]","[email protected]"]
}

Nach dem erfolgreichen Versand dieser Nutzlast bestätigt diese Antwort, dass Braze die E-Mails aus der Spam-Liste von MovieCanon entfernt hat.

1
2
3
{
  "message": "success"
}

Prüfen aller Canvase

Siege Valley Health ist ein Krankenhaussystem, zu dem 10 Betreiber von Krankenhäusern und Forschungszentren mit Tausenden von Patienten gehören. Das Team des Marketers möchte die Canvase, die an Patienten verschickt wurden, um sie an einen Zeitplan für die Grippeimpfung zu erinnern, mit den Ergebnissen der letzten 3 Jahre vergleichen, in denen Braze verwendet wurde. Das Marketing Team von Siege Valley Health wünscht sich außerdem eine schnelle und effiziente Möglichkeit, sowohl die Liste der Canvase als auch die Analytics-Zusammenfassung einzusehen.

Sehen wir uns an, wie Siege Valley Health diese beiden Aufgaben mit einer Kombination von Endpunkten erfüllen kann, anstatt über das Braze-Dashboard zu filtern.

Für die erste Aufgabe der Prüfung von Canvase verwenden Sie den Endpunkt /canvas/list, um eine Liste der Canvase zu exportieren, die den Namen und die Tags enthält. Hier ein Beispiel für eine Anfrage:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "canvases" : [
  	{
  		"id": "canvas_identifier_1",
  		"last_edited": "2020-07-10T23:59:59",
  		"name": "PatientReminder_FluShot_2020",
  		"tags": {
        "flu_shots", "patienthealth", "2020"
      }
  	},
  	{
  		"id": "canvas_identifier_2",
  		"last_edited": "2020-07-30T23:59:59",
  		"name": "PatientReminder2_FluShot_2020",
  		"tags": {
        "flu_shots", "patienthealth", "reminder", "2020"
      }
  	},
    ... (more Canvases)
  ],
  "message": 'success'
}

Lassen Sie uns als nächstes die Analytics-Zusammenfassung für den ersten Canvas aus der Liste der Canvase von Siege Valley Health anzeigen. Dazu verwenden wir den Endpunkt /canvas/data_summary mit den folgenden Anfrage-Parametern:

• canvas_id: “canvas_identifier_2”
• ending_at: 2023-07-10T23:59:59
• starting_at: 2020-07-10T23:59:59

Hier ein Beispiel für eine Anfrage:

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/canvas/data_summary?canvas_id=&ending_at=2023-07-10T23:59:59&starting_at=2020-07-10T23:59:59&length=5&include_variant_breakdown=false&include_step_breakdown=false&include_deleted_step_data=false' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Prüfen der anstehenden geplanten Kampagnen und Canvase

Die geschäftigste Zeit des Jahres rückt für Flash&Thread, eine Einzelhandelsmarke, die Kleidung und Beauty-Produkte online und in Shops verkauft, schnell näher. Sein Marketing Team möchte die anstehenden Kampagnen und Canvase vor dem 31. März 2024 um 12 Uhr auf dem Braze-Dashboard überprüfen. Dies kann über den Endpunkt /messages/scheduled_broadcasts erfolgen.

Hier ist die Beispielanfrage:

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/messages/scheduled_broadcasts?end_time=2024-03-31T12:00:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Dieser Endpunkt gibt die Liste der bevorstehenden Kampagnen und Canvases zurück. Von hier aus kann das Marketing Team seine Liste der Nachrichten bestätigen, indem es sich auf das Feld name für die Kampagnen und Canvase in der Antwort bezieht.

Anzeigen eines älteren Einstellungszentrums

PoliterWeekly ist eine digitale Zeitschrift, deren Abonnent:innen per E-Mail erreichbar sind. Um die User Journey seiner Abonnent:innen besser zu verstehen, möchte das Marketingteam die Details des Präferenzzentrums von PoliterWeekly überprüfen, um festzustellen, wann es erstellt und zuletzt aktualisiert wurde.

Bei Verwendung des Endpunkts /preference_center/v1/{preferenceCenterExternalID} muss das Marketing Team lediglich die externe ID des Einstellungszentrums als Pfadparameter einfügen, was wie folgt aussehen würde:

1
2
curl --location -g --request GET https://rest.iad-01.braze.com/preference_center/v1/politer_weekly_preference_center_api_id \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "name": "PoliterWeekly Notification Preferences",
  "preference_center_api_id": "user_engage_pref_123",
  "created_at": "2021-04-03T12:00:00",
  "updated_at": "2024-08-15T15:00:00",
  "preference_center_title": "Manage Your PoliterWeekly Notification Preferences",
  "preference_center_page_html": "<!DOCTYPE html><html><head><title>Your PoliterWeekly Newsletter Preferences</title><style>body { font-family: Arial, sans-serif; margin: 0; padding: 20px; }.container { max-width: 600px; margin: auto; }h1 { color: #333; }.preference { margin-bottom: 20px; }.preference label { font-size: 16px; }.preference input[type=\"checkbox\"] { margin-right: 10px; }.submit-btn { background-color: #007bff; color: white; padding: 10px 20px; border: none; cursor: pointer; }</style></head><body><div class=\"container\"><h1>Manage your notification preferences</h1><p>Select the types of updates you wish to receive from us:</p><form id=\"preferencesForm\"><div class=\"preference\"><label><input type=\"checkbox\" name=\"newsUpdates\" checked> News Updates</label></div><div class=\"preference\"><label><input type=\"checkbox\" name=\"editorialPicks\"> Editorial Picks</label></div><div class=\"preference\"><label><input type=\"checkbox\" name=\"events\"> Events & Webinars</label></div><div class=\"preference\"><label><input type=\"checkbox\" name=\"specialOffers\"> Special Offers & Promotions</label></div><button type=\"submit\" class=\"submit-btn\">Save Preferences</button></form></div><script>document.getElementById('preferencesForm').addEventListener('submit', function(e) {e.preventDefault();alert('Your preferences have been saved!');});</script></body></html>",
  "confirmation_page_html": "<!DOCTYPE html><html><head><title>PoliterWeekly Preferences Updated</title></head><body><h1>You're good to go!</h1><p>Braze updated your preferences successfully.</p></body></html>",
  "redirect_page_html": null,
  "preference_center_options": {
    "meta-viewport-content": "width=device-width, initial-scale=1"
  },
  "state": "active"
}

Entfernen von ungültigen Telefonnummern

Das Hauptziel von CashBlastr ist es, die Art und Weise, wie Menschen schnelle Zahlungen senden und empfangen können, zu optimieren. Als Unternehmen für Serviceleistungen im Finanzbereich möchte CashBlastr die Liste der Telefonnummern für seine Kund:in aktuell und korrekt halten. Das Entwickler:in Team wurde beauftragt, die folgende Liste der als “ungültig” markierten Telefonnummern zu entfernen, damit die SMS-Nachrichten des Marketing-Teams die entsprechenden CashBlastr-Kunden erreichen können.

• 12223135467
• 12183095514
• 14235662245
• 14324567892

Um eine Anfrage mit dem Endpunkt /sms/invalid_phone_numbers/remove zu senden, müssen die Telefonnummern in einem String-Array im Format e.164 vorliegen, mit bis zu 50 Telefonnummern pro Anfrage. Da die Liste nicht mehr als 50 Telefonnummern umfasst, hier ein Beispiel für den Text der Anfrage, die das Entwickler:in Team von CashBlastr senden würde:

1
2
3
4
5
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "phone_numbers": ["12183095514","14255551212"]
}

Nach dem Senden dieser Nutzlast bestätigt die Antwort, dass Braze die ungültigen Telefonnummern von CashBlastr aus der Braze-Liste ungültiger Nummern entfernt hat.

1
2
3
{
  "message": "success"
}

Anzeigen des Abo-Gruppenstatus eines Nutzers:innen

SandwichEmperor ist eine Schnellrestaurantkette in den Vereinigten Staaten, deren Marketing Team die Abo-Gruppenstatus für eine zufällige Liste ihrer Nutzer:innen per SMS überprüfen möchte. Mit dem Endpunkt /subscription/status/get kann SandwichEmperor diese Aufgabe für einen einzelnen Nutzer:innen mit der folgenden Beispielanfrage erfüllen:

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&phone=+11232223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Dieser Endpunkt listet auch die Abo-Gruppenstatus einer Nutzer:in für E-Mails auf. Verwenden Sie diese Funktion, um den Abo-Gruppenstatus für mehrere Nutzer:innen anzuzeigen.

Prüfen eines HTML Templates für E-Mail Messaging

Bei WorkFriends, einem sozialen Netzwerk, das den Aufbau von Verbindungen zwischen Arbeitnehmern aus verschiedenen Branchen unterstützt, ist das Marketing Team für den Versand von E-Mail Kampagnen an seine Nutzer:innen verantwortlich. Diese Kampagnen beinhalten häufig Erinnerungen an lokale Veranstaltungen, wöchentliche Newsletter und die Hervorhebung von Profilaktivitäten.

In diesem Szenario hat WorkFriends in der Vergangenheit ein singuläres HTML Template mit seinem alten Branding verwendet. In dem Bestreben, seine Markenidentität anzugleichen, möchte WorkFriends überprüfen, ob diese HTML-Vorlage hilfreiche Informationen enthält, die es zu nutzen gilt, bevor es auf ein neues Template umsteigt.

1
2
3
4
5
6
7
8
9
10
11
{
  "email_template_id": "WorkFriends_Email_Template_ID",
  "template_name": "Promo template",
  "description": "Promo template",
  "subject": "WorkFriends Weekly Newsletter",
  "preheader": "Another week, another WorkFriends update",
  "body": "<!DOCTYPE html><html><head><title>WorkFriends Weekly Newsletter</title><style>body {font-family: Arial, sans-serif; color: #333;}.container {padding: 20px;}.header {background-color: #f2f2f2; padding: 10px; text-align: center;}.content {margin-top: 20px;}.footer {margin-top: 20px; font-size: 12px; text-align: center; color: #777;}</style></head><body><div class=\"container\"><div class=\"header\"><h2>WorkFriends Weekly Newsletter</h2></div><div class=\"content\"><p>Hello WorkFriends,</p><p>Welcome to another edition of our weekly newsletter. We've got some exciting updates and promos for you this week!</p><!-- Add more content here --><p>Don't forget to check out our latest promos and updates. Stay connected, stay informed!</p></div><div class=\"footer\"><p>Thank you for being a part of WorkFriends.</p><p>Unsubscribe | Update Preferences</p></div></div></body></html>",
  "tags": "promo",
  "created_at": "2020-07-10 13:00:00.000",
  "updated_at": "2024-02-04 17:00:00.000"
}

Nach Überprüfung dieser Template-Informationen kann WorkFriends auch den Endpunkt /templates/email/update verwenden, um das E-Mail Template über die API zu aktualisieren. Das E-Mail-Template im Braze-Dashboard spiegelt diese Änderungen wider.