Obtención de datos a través del Contenido conectado

Con el contenido conectado Braze, puedes obtener datos de la API de Voucherify y enviar mensajes a segmentos específicos de Braze. Este artículo de referencia te mostrará cómo configurar los scripts de Contenido conectado para publicar cupones de Voucherify, invitar a nuevos referidos, recuperar el saldo de las tarjetas de fidelización y mucho más.

Esta integración es mantenida por Voucherify.

Sobre la integración

El esquema básico del guion es el siguiente:

1
2
3
4
5
6
7
8
9
10
11
{% connected content
  "voucherify-API-ENDPOINT-url"
  :method post
  :headers {
    "X-App-Id": "Voucherify-API-key",
    "X-App-Token": "Voucherify-Secret-key",
  }
  :content_type application/json
  :retry
  :save {{result_variable}}
}

Visita el repositorio GitHub de Voucherify para ver ejemplos de scripts de Contenido conectado.

Configuración de seguridad

Sin la siguiente configuración, cada vez que se desencadene un mensaje de Contenido conectado, se llamará a la API de Voucherify al menos dos veces. Estas configuraciones reducen el número de llamadas a la API facturadas a Braze y reducen el riesgo de alcanzar el límite de bloqueo duro de la API, que puede interrumpir la entrega de mensajes.

• limitador de velocidad
• almacenamiento en caché
• atributo de reintento
• publicaciones únicas
• únete una vez

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign cache_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}

{% connected_content
   https://api.voucherify.io/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
    "X-App-Id": "VOUCHERIFY-APP-ID",
    "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

Casos prácticos

Ten en cuenta que todos los casos de uso siguientes utilizan el ID de origen de publicación de Voucherify y los parámetros de caché y reintento de Braze para limitar las llamadas a la API invocadas por una campaña Braze. Debes ser consciente de las siguientes consecuencias:

• No es posible publicar y enviar códigos diferentes al mismo cliente en una sola campaña Braze.
• Si tu campaña de Voucherify utiliza la característica de unirse sólo una vez, tienes que eliminar source_id del cuerpo del contenido conectado, tal y como se describe en la pestaña de unirse sólo una vez anterior.

Visita el repositorio GitHub de Voucherify para ver ejemplos de scripts de Contenido conectado.

Publica y envía un código de cupón único

En este caso de uso, el script Contenido conectado llama a la API de Voucherify para publicar un código de cupón único y enviarlo en el mensaje Braze. Cada usuario de Braze recibe un único código.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign cache_id = source_id %}

{% connected_content
   YOUR API ENDPOINT/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

Invita a nuevos referidos

Si quieres que un cliente se una a un programa de referidos, tienes que asignarle un código de referidos. El Contenido conectado sigue siendo el mismo que en el ejemplo anterior. Este script de contenido conectado te habilita para publicar y enviar códigos únicos de referidos a usuarios seleccionados de Braze. Cada usuario recibe un único código de referidos para compartirlo con otros usuarios y conseguir nuevos referidos.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign cache_id = source_id %}

{% connected_content
   YOUR API ENDPOINT/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

Consultar el saldo de la tarjeta de fidelización

Este es un caso de uso de un script de Contenido conectado que extrae el saldo de fidelización actual basándose en el código de la tarjeta de fidelización que se envió previamente a Braze como atributo personalizado. Ten en cuenta que debes almacenar el código de la tarjeta de fidelización como un atributo personalizado en el perfil de usuario de Braze antes de utilizar este script.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign cache_id = source_id %}

{% connected_content
   YOUR API ENDPOINT/v1/loyalties/members/{{custom_attribute.${loyalty.card}}}?cache_id={{cache_id}}
   :method get
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :content_type application/json
   :cache_max_age
   :retry
   :save member
 %}

Crear código personalizado

Connected Content (contenido conectado) es una potente herramienta que permite introducir escenarios creativos. Puedes crear un código de cupón personalizado basado en la información del perfil del cliente.

Aquí tienes un fragmento de código que tendrá en cuenta el número de teléfono del cliente para generar un código único. En este caso de uso, el script de Contenido conectado llama a la API de Voucherify para publicar un código de cupón personalizado.

1. Primero, define todas las variables necesarias. A continuación, crea un código de cupón que empiece por el prefijo “SummerTime-“ y el resto del código será el número de teléfono del cliente. Puedes decidir en qué atributo personalizado quieres basar tus códigos de cupón.

   1
   2
   3
   4
   5
   6
   7
   {% assign braze_campaign_id = {{campaign.${dispatch_id}}} %}
   {% assign customer_id = {{${user_id}}} %}
   {% assign phoneNumber = {{${phone_number}}} %}
   {% assign source_id = braze_campaign_id | append: customer_id %}
   {% assign cache_id = source_id %}
   {% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
   {% assign prefix = "SummerTime-" %}
   

2. A continuación, solicita a Voucherify que genere un código único en la campaña. Proporcionamos el nombre del código del cupón que se creará en la URL:

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   {% connected_content
      YOUR-API-ENDPOINT/v1/campaigns/{{voucherify_campaign_id}}/vouchers/{{prefix}}{{phoneNumber}}?cache_id={{cache_id}}
      :method post
      :headers {
           "X-App-Id": "VOUCHERIFY-APP-ID",
           "X-App-Token": "VOUCHERIFY-APP-TOKEN"
      }
      :content_type application/json
      :cache_max_age 
      :save voucher_created
      :retry
   %}  
   

3. Por último, publica el código que acabas de crear. El fragmento de código es prácticamente igual al que utilizaste para generar un vale aleatorio a partir de una campaña. Sin embargo, esta vez nos dirigimos a un código de cupón específico.

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   {% connected_content
      YOUR-API-ENDPOINT/v1/publications?cache_id={{cache_id}}
      :method post
      :headers {
          "X-App-Id": "VOUCHERIFY-APP-ID",
          "X-App-Token": "VOUCHERIFY-APP-TOKEN"
      }
      :body voucher={{prefix}}{{phoneNumber}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
      :content_type application/json
      :cache_max_age 
      :save publication
      :retry
   %}
   

Como resultado, el cliente recibe el siguiente correo electrónico:

Aquí tienes el fragmento de código completo utilizado en este ejemplo:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{% assign braze_campaign_id = {{campaign.${dispatch_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign phoneNumber = {{${phone_number}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign cache_id = source_id %}
{% assign voucherify_campaign_id = "VOUCHERIFY-CAMPAIGN_ID" %}
{% assign prefix = "Your Prefix" %}

{% connected_content
   YOUR-API-ENDPOINT/v1/campaigns/{{voucherify_campaign_id}}/vouchers/{{prefix}}{{phoneNumber}}?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "VOUCHERIFY-APP-ID",
        "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :content_type application/json
   :cache_max_age 
   :save voucher_created
   :retry
%} 

{% connected_content
   YOUR-API-ENDPOINT/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
       "X-App-Id": "VOUCHERIFY-APP-ID",
       "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   }
   :body voucher={{prefix}}{{phoneNumber}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age 
   :save publication
   :retry
%}

Mostrar datos obtenidos en mensajes Braze

Suponemos que ya tienes una campaña Braze o un Canvas en el que quieres utilizar el script de Contenido conectado.

Paso 1: Añadir secuencia de comandos de contenido conectado a la plantilla de mensajes

1. Copia y pega el script Contenido conectado bajo la etiqueta <body> en una plantilla HTML de mensaje. Sustituye CAMPAIGN_ID por un campaign_id de Voucherify copiado de la dirección URL del panel de campaña de Voucherify.
   

   1
   assign voucherify_campaign_id = "camp_Y7h1meBSyybsNs7UpSVVZZce"
   

2. Proporciona tu punto final de la API de Voucherify. Si no sabes cuál es tu punto final de API, puedes comprobarlo en la configuración del proyecto > General > Punto final de API.
   

   1
    YOUR API ENDPOINT/v1/publications?cache_id={{cache_id}}
   

   Clúster compartido	Punto final para contenido conectado Braze
   Europa (predeterminado)	https://api.voucherify.io/v1/publications
   Estados Unidos	https://us1.api.voucherify.io/v1/publications
   Asia (Singapur)	https://as1.api.voucherify.io/v1/publications

3. Añade tus claves de API para la autenticación. Puedes encontrar Voucherify-App-Id y Voucherify-App-Token en tu Configuración del proyecto > General >Teclas de aplicación.
   

   1
   2
   "X-App-Id": "VOUCHERIFY-APP-ID",
   "X-App-Token": "VOUCHERIFY-APP-TOKEN"
   

Ahora tu guión de Contenido conectado está listo para funcionar.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{% assign braze_campaign_id = {{campaign.${api_id}}} %}
{% assign customer_id = {{${user_id}}} %}
{% assign source_id = braze_campaign_id | append: customer_id %}
{% assign voucherify_campaign_id = "camp_Y7h1meBSyybsNs7UpSVVZZce" %}
{% assign cache_id = source_id %}

{% connected_content
   https://api.voucherify.io/v1/publications?cache_id={{cache_id}}
   :method post
   :headers {
        "X-App-Id": "490a3fb6-a",
        "X-App-Token": "328099d5-a"
   }
   :body campaign={{voucherify_campaign_id}}&customer={{customer_id}}&channel=Braze&source_id={{source_id}}
   :content_type application/json
   :cache_max_age
   :retry
   :save publication
 %}

Paso 2: Crea un fragmento de código para mostrar los datos obtenidos

Las respuestas de la API de Voucherify son almacenadas por el Contenido Conectado bajo el valor del parámetro :save. Por ejemplo:

1
:save member

Esto te permite recuperar y mostrar datos de una respuesta de Voucherify en mensajes Braze.

Puedes crear fragmentos de código que muestren el código publicado, el saldo de la tarjeta de fidelización, la fecha de caducidad y otros parámetros incluidos en la respuesta en formato JSON de la API de Voucherify.

Por ejemplo, para mostrar el código publicado en una plantilla de mensajes, debes crear un fragmento de código que obtenga un código único del objeto vale.

Script de contenido conectado:

Fragmento de plantilla de mensaje Braze:

1
{{publication.voucher.code}}

Como resultado, cada cliente recibe un mensaje con un código único asignado automáticamente a su perfil. Cada vez que el usuario recibe un código, este se publica en su perfil de Voucherify.

Para mostrar el saldo de una tarjeta de fidelización obtenida de la API de Voucherify, tienes que crear el siguiente fragmento de código:

1
{{member.loyalty_card.balance}}

donde el miembro es un valor del parámetro :save del guion Contenido conectado.

1
:save member

Te aconsejamos encarecidamente que no dependas totalmente del “modo vista previa” y que envíes varios mensajes de prueba para confirmar que todo funciona como debería.

Paso 3: Configurar el límite de velocidad

Cuando configures un objetivo de campaña, utiliza la configuración avanzada para limitar el número de mensajes enviados por minuto.

Más información sobre el limitador de tasa y la limitación de frecuencia en la documentación de Braze.