API de personalización de Hightouch

La API de personalización de Hightouch es un servicio gestionado que le permite alojar una API de datos de baja latencia basada en cualquier conjunto de datos de su almacén de datos en la nube.

La integración de Braze y Hightouch le permite utilizar la API con Braze Connected Content para extraer datos actualizados de clientes u objetos en sus campañas o Canvases en el momento del envío.

La API de personalización de Hightouch proporciona un punto final REST para utilizar en la configuración de Braze. En concreto, puedes utilizar la oferta de contenido conectado Braze para realizar una solicitud GET a la API de personalización para recuperar toda la información relacionada con un identificador concreto. Los datos expuestos por esta API pueden representar datos de clientes, productos o cualquier otro objeto.

Requisitos previos

• casos de uso
• conjuntos de datos

Integración

Paso 1: Conectar fuente de datos a Hightouch

Las fuentes Hightouch son el lugar donde residen los datos empresariales de su organización. En este caso, es dondequiera que se almacenen los datos de sus usuarios.

1. En Hightouch, vaya a Visión General de Fuentes > Añadir Fuente. Seleccione su almacén de datos como fuente.
   
   
2. Introduzca las credenciales pertinentes, que variarán en función de la fuente.

Para más detalles, consulta la documentación de origen correspondiente.

Paso 2: Datos del modelo

Los modelos Hightouch definen qué datos extraer de su fuente. Para configurar un nuevo modelo, sigue estos pasos:

1. En Hightouch, vaya a Resumen de modelos > Añadir modelo y selecciona la fuente que acabas de conectar.
   
   
2. A continuación, elija un método de modelización. Como toda la información debe estar unida en una tabla, puede utilizar el selector visual de tablas para definirla. Como alternativa, puede escribir SQL para incluir sólo las columnas que desee o basarse en sus modelos dbt, Looker Looks o libros de trabajo Sigma existentes.
   
   
3. Antes de continuar, previsualiza tu modelo para asegurarte de que consulta los datos que te interesan. Por defecto, Braze limita la vista previa a los 100 primeros registros. Una vez validados los datos, haz clic en Continuar.
   
   
4. Nombre su modelo, por ejemplo, “Recomendaciones de usuarios”.
   
   
5. Por último, seleccione una clave primaria y haga clic en Finalizar. Una clave primaria debe ser una columna con identificadores únicos. Este es también el campo que utilizará para llamar a la API de personalización para recuperar las recomendaciones de un usuario en particular.

Paso 3: Configurar la API de personalización

Preparar la API para recibir peticiones tiene dos pasos:

• Habilitación de la API de personalización en las regiones más cercanas a su infraestructura
• Creación de sincronizaciones para definir qué modelos deben materializarse en la caché gestionada por Hightouch.

Siga estas instrucciones para completar ambos:

1. En Hightouch, vaya a Destinos y seleccione la API de personalización de Hightouch creada para usted. Si no tiene habilitado este destino, póngase en contacto con el servicio de asistencia de Hightouch.
   
   
2. A continuación, seleccione la región adecuada. Seleccionar la región más cercana a su infraestructura reducirá sus tiempos de respuesta. Si no ve una región cercana a su infraestructura, póngase en contacto con el servicio de asistencia de Hightouch.
   
   
3. Vaya a la página de resumen desincronizaciones y haga clic en el botón Añadir sincronización. A continuación, seleccione el modelo correspondiente y el destino que haya configurado previamente.
   
   
4. Introduzca un nombre alfanumérico para la colección. Las colecciones son conceptualmente similares a las tablas de las bases de datos. Cada uno debe representar un tipo de datos concreto, como clientes o facturas. Los nombres de las colecciones deben ser alfanuméricos y formarán parte de su punto final de la API de personalización.
   
   
5. A continuación, especifique qué columna de su modelo debe servir como índice primario para las búsquedas de registros. Este campo debe identificar de forma exclusiva cada registro de la colección y suele coincidir con la clave primaria de su modelo. La API de personalización admite búsquedas en varios índices. Por ejemplo, puede que quieras recuperar perfiles de clientes utilizando user_id, anonymous_id, o email_address. Para activar varios índices, póngase en contacto con el servicio de asistencia de Hightouch.
   
   
6. Utilice el mapeador de campos para especificar qué columnas de su modelo deben incluirse en la carga útil de la respuesta de la API. Puede cambiar el nombre de estos campos y utilizar el mapeador avanzado para aplicar transformaciones utilizando el lenguaje de plantillas Liquid.
   
   
7. Seleccione el comportamiento de eliminación adecuado para su caso de uso.
   
   
8. Por último, haz clic en Continuar y selecciona un calendario de sincronización.

Hightouch sincronizará ahora los datos de su almacén con una base de datos gestionada y los expondrá a través de la API de personalización.

Paso 4: Llama a la API de personalización a través del contenido conectado Braze

Una vez que haya configurado su instancia de API de personalización, puede utilizarla como un punto final de contenido conectado Braze.

Se puede acceder a la API en https://personalization.{region}.hightouch.com, por ejemplo, https://personalization.us-west-2.hightouch.com.

La información está disponible utilizando este punto final /v1/collections/:collection_name/records/:index_key/:index_value.

Por ejemplo, puede incluir este fragmento en una campaña o Canvas:

1
2
3
4
5
6
7
8
9
{% connected_content
     https://personalization.us-west-2.hightouch.com/v1/collections/customer/records/id/12345
     :method get
     :headers {
       "Authorization": "Bearer {{YOUR-API-KEY}}"
  }
     :content_type application/json
     :save customer
%}

Puede utilizar la plantilla Liquid para hacer referencia a las propiedades devueltas en la carga JSON y utilizarlas en su mensajería.

Para el siguiente ejemplo de carga útil:

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
35
36
37
38
39
{
    "user_id": 12345,
    "full_name": "Jane Doe",
    "lifetime_value": 1492.18,
    "churn_risk": 0.04,
    "90_day_summary": {
        "num_songs_listened": 813,
        "top_genres": [
            "house",
            "techno",
            "ambient"
        ],
        "top_artists": [
            "deadmau5",
            "Marsh",
            "Enamour"
        ],
    },
    "recommendations": {
        "concerts": [
            {
                "artist": "Aphex Twin",
                "location": "San Francisco, CA",
                "event_date": "2023-01-31"
            },
            {
                "artist": "Sultan + Shepard",
                "location": "San Francisco, CA",
                "event_date": "2023-02-25"
            }
        ],
        "upcoming_album_release": {
            "title": "Universal Language",
            "artist": "Simon Doty",
            "label": "Anjunadeep",
            "release_date": "2023-04-28"
        }
    },
}

Las siguientes referencias de Liquid devolverían estos datos de ejemplo:

Solución de problemas

Si tiene alguna pregunta, póngase en contacto con el servicio de asistencia de Hightouch.