Casos de uso de la API

La REST API de Braze proporciona una amplia gama de puntos finales diseñados para ayudar a gestionar y optimizar tu estrategia de interacción con los clientes. En este artículo, exploraremos varios casos de uso para cada colección de puntos finales: catálogos, listas de correo electrónico y direcciones, exportación, mensajes, centro de preferencias, SMS, grupos de suscripción, plantillas y datos de usuario.

Cada sección presenta un escenario con una guía paso a paso, un ejemplo de código y el resultado esperado. Al final de este artículo, comprenderás mejor cómo utilizar la REST API de Braze para mejorar tus esfuerzos de interacción con los clientes.

Eliminación de varios artículos en un catálogo

Un nuevo año trae nuevos lanzamientos de productos en Kitchenerie, una marca de comercio minorista especializada en utensilios de cocina. En el panel de Braze, Kitchenerie tiene un catálogo configurado para su colección de vajilla llamado “Dishware”. Este nuevo año también significa eliminar los siguientes productos de su colección de vajilla.

• Plain Bisque
• Pearl Porcelain
• Pink Shimmer

Para eliminar estos productos de su catálogo, Kitchenerie puede utilizar el endpoint /catalogs/{catalog_name}/items para pasar los ID de los artículos.

Este es el ejemplo de la solicitud:

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"}
  ]
}'

Después de enviar esta carga útil, la respuesta confirma que Braze eliminó con éxito las tres colecciones del catálogo de vajilla de Kitchenerie.

1
2
3

{
  "message": "success"
}

Eliminar correos electrónicos de la lista de correo no deseado de Braze

En MovieCanon, una empresa de servicios de streaming, el equipo de desarrolladores es responsable de auditar periódicamente sus listas de correo electrónico para identificar y mantener a los usuarios que están suscritos a sus Campaigns de correo electrónico. Como parte de esta auditoría, MovieCanon quiere eliminar esta lista de correos electrónicos de su lista de correo no deseado:

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

Para realizar esta tarea, el equipo de desarrolladores necesita una clave de API con el permiso email.spam.remove para utilizar el endpoint /email/spam/remove. Este endpoint elimina direcciones de correo electrónico de la lista de correo no deseado de Braze y de la lista de correo no deseado mantenida por el proveedor de correo electrónico de MovieCanon.

Para enviar esta solicitud, incluye una dirección de correo electrónico como cadena o una matriz de hasta 50 direcciones de correo electrónico a modificar. Como la lista de correos electrónicos a eliminar es menor de 50, MovieCanon puede realizar esta tarea con el siguiente cuerpo de solicitud:

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]"]
}

Tras enviar esta carga útil correctamente, esta respuesta confirma que Braze eliminó los correos electrónicos de la lista de correo no deseado de MovieCanon.

1
2
3

{
  "message": "success"
}

Auditoría de todos los Canvas

Siege Valley Health es un sistema hospitalario que incluye 10 hospitales en funcionamiento y centros de investigación con miles de pacientes. Su equipo de marketing quiere comparar los Canvas enviados a los pacientes para recordarles que programen una cita para la vacuna contra la gripe durante los últimos 3 años de uso de Braze. El equipo de marketing de Siege Valley Health también quiere una forma rápida y eficiente de ver tanto la lista de Canvas como el resumen de análisis.

El siguiente ejemplo muestra cómo Siege Valley Health puede lograr estas dos tareas utilizando una combinación de endpoints en lugar de filtrar a través del panel de Braze.

Para la primera tarea de auditar los Canvas, utiliza el endpoint /canvas/list para exportar una lista de Canvas que incluya el nombre y las etiquetas. Este es un ejemplo de solicitud:

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'
}

Pasemos a la siguiente tarea de ver el resumen de análisis del primer Canvas de la lista de Canvas de Siege Valley Health. Para hacerlo, utilizaríamos el endpoint /canvas/data_summary con los siguientes parámetros de solicitud:

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

Este es un ejemplo de solicitud:

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'

Comprobación de Campaigns y Canvas programados próximos

Se acerca rápidamente la época más ajetreada del año para Flash & Thread, una marca de comercio minorista que vende ropa y productos de belleza en línea y en tiendas. Su equipo de marketing quiere comprobar las próximas Campaigns y Canvas desde el panel de Braze antes del 31 de marzo de 2024 a las 12 p. m. Esto se puede lograr utilizando el endpoint /messages/scheduled_broadcasts.

Este es el ejemplo de solicitud:

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'

Este endpoint devuelve la lista de Campaigns y Canvas próximos. A partir de aquí, el equipo de marketing puede confirmar su lista de mensajes consultando el campo name de las Campaigns y Canvas en la respuesta.

Ver un centro de preferencias anterior

PoliterWeekly es una revista digital cuyos suscriptores son accesibles a través de correo electrónico. Con el fin de comprender mejor el recorrido de usuario de sus suscriptores, el equipo de marketing quiere revisar los detalles del centro de preferencias de PoliterWeekly para comprobar cuándo se creó y cuándo se actualizó por última vez.

Utilizando el endpoint /preference_center/v1/{preferenceCenterExternalID}, el equipo de marketing solo necesita insertar el ID externo del centro de preferencias como parámetro de ruta, que tendría este aspecto:

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"
}

Eliminación de números de teléfono no válidos

En CashBlastr, el objetivo principal es simplificar la forma en que las personas pueden enviar y recibir pagos rápidos. Como empresa de servicios financieros, CashBlastr quiere mantener su lista de números de teléfono de sus clientes actualizada y precisa. El equipo de desarrolladores ha recibido la tarea de eliminar la siguiente lista de números de teléfono marcados como “no válidos” para que los mensajes SMS del equipo de marketing puedan llegar a los clientes adecuados de CashBlastr.

• 12223135467
• 12183095514
• 14235662245
• 14324567892

Para enviar una solicitud con el endpoint /sms/invalid_phone_numbers/remove, los números de teléfono deben estar en una matriz de cadenas en formato e.164, con hasta 50 números de teléfono por solicitud. Como la lista no supera los 50 números de teléfono, aquí tienes un ejemplo del cuerpo de la solicitud que enviaría el equipo de desarrolladores de CashBlastr:

1
2
3
4
5

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

Después de enviar esta carga útil, la respuesta confirma que Braze eliminó los números de teléfono no válidos de CashBlastr de la lista de no válidos de Braze.

1
2
3

{
  "message": "success"
}

Consultar el estado del grupo de suscripción de un usuario

SandwichEmperor es una cadena de restaurantes de servicio rápido en Estados Unidos, y su equipo de marketing quiere comprobar los estados de los grupos de suscripción de una lista aleatoria de sus usuarios para SMS. Mediante el endpoint /subscription/status/get, SandwichEmperor puede llevar a cabo esta tarea para un usuario individual con la siguiente solicitud de ejemplo:

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'

Este endpoint también muestra los estados de los grupos de suscripción de un usuario para correo electrónico. Úsalo para consultar el estado del grupo de suscripción de varios usuarios.

Verificación de una plantilla HTML para mensajería de correo electrónico

En WorkFriends, una red social que ayuda a crear conexiones entre trabajadores de diferentes industrias, su equipo de marketing es responsable de enviar campañas de correo electrónico a sus usuarios. Estas campañas suelen incluir recordatorios de eventos locales, boletines semanales y resúmenes de actividad del perfil.

En este escenario, WorkFriends ha utilizado históricamente una única plantilla HTML con su imagen de marca anterior. Con el objetivo de alinear su identidad de marca, WorkFriends quiere verificar si hay alguna información útil en esta plantilla HTML que pueda aprovechar antes de hacer la transición a una nueva plantilla.

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"
}

Después de revisar la información de esta plantilla, WorkFriends también puede usar el endpoint /templates/email/update para actualizar la plantilla de correo electrónico a través de la API. La plantilla de correo electrónico en el panel de Braze refleja estas ediciones.