API de personnalisation Hightouch

L’API de personnalisation de Hightouch est un service géré qui vous permet d’héberger une API de données à faible latence basée sur n’importe quel ensemble de données de votre entrepôt de données cloud.

L’intégration de Braze et Hightouch vous permet d’utiliser l’API avec Braze Connected Content pour intégrer des données à jour sur les clients ou les objets à vos campagnes ou Canvases au moment de l’envoi.

L’API de personnalisation de Hightouch fournit un endpoint REST à utiliser dans votre configuration Braze. Plus précisément, vous pouvez utiliser l’offre de contenu connecté de Braze pour envoyer une requête GET à l’API de personnalisation afin de récupérer toutes les informations relatives à un identifiant particulier. Les données exposées par cette API peuvent représenter des données relatives à un client, à un produit ou à tout autre objet.

Conditions préalables

• cas d'utilisation
• ensembles de données

Intégration

Étape 1 : Connecter la source de données à Hightouch

Les sources Hightouch sont l’endroit où se trouvent les données commerciales de votre organisation. Dans ce cas, il s’agit de l’endroit où vos données utilisateur sont stockées.

1. Dans Hightouch, accédez à Aperçu des sources > Ajouter une source. Sélectionnez votre entrepôt de données comme source.
   
   
2. Entrez les informations d’identification pertinentes ; elles varient en fonction de la source.

Pour plus de détails, reportez-vous à la documentation de la source correspondante.

Étape 2 : Données du modèle

Les modèles Hightouch définissent les données à extraire de votre source. Pour configurer un nouveau modèle, procédez comme suit :

1. Dans Hightouch, accédez à Aperçu des modèles > Ajouter un modèle, puis sélectionnez la source que vous venez de connecter.
   
   
2. Choisissez ensuite une méthode de modélisation. Comme toutes vos informations doivent être réunies dans un seul tableau, vous pouvez utiliser le sélecteur de tableau visuel pour les définir. Vous pouvez également écrire du code SQL pour n’inclure que les colonnes que vous souhaitez ou vous appuyer sur vos modèles DBT, Looker Looks ou Sigma existants.
   
   
3. Avant de continuer, prévisualisez votre modèle pour vous assurer qu’il interroge les données qui vous intéressent. Par défaut, Braze limite l’aperçu aux 100 premiers enregistrements. Après avoir validé vos données, cliquez sur Continuer.
   
   
4. Donnez un nom à votre modèle, par exemple « Recommandations aux utilisateurs ». «
   
   
5. Enfin, sélectionnez une clé primaire et cliquez sur Terminer. Une clé primaire doit être une colonne contenant des identifiants uniques. C’est également le champ que vous utiliserez pour appeler l’API de personnalisation afin de récupérer les recommandations d’un utilisateur en particulier.

Étape 3 : Configuration de l’API de personnalisation

La préparation de l’API pour recevoir les requêtes comporte deux étapes :

• Activation de l’API de personnalisation dans les régions les plus proches de votre infrastructure
• Création de synchronisations pour définir quels modèles doivent être matérialisés dans le cache géré par HighTouch

Suivez ces instructions pour effectuer les deux opérations :

1. Dans Hightouch, accédez à Destinations et sélectionnez l’API de personnalisation Hightouch créée pour vous. Si cette destination n’est pas activée, contactez l’assistance Hightouch.
   
   
2. Sélectionnez ensuite la région appropriée. La sélection de la région la plus proche de votre infrastructure réduira vos temps de réponse. Si aucune région n’est proche de votre infrastructure, contactez le service d’assistance de Hightouch.
   
   
3. Accédez à la page d’aperçu des synchronisations et cliquez sur le bouton Ajouter une synchronisation. Sélectionnez ensuite le modèle approprié et la destination que vous avez précédemment configurée.
   
   
4. Entrez un nom de collection alphanumérique. Les collections sont conceptuellement similaires aux tables de base de données. Chacune doit représenter un type de données particulier, tel que les clients ou les factures. Les noms des collections doivent être alphanumériques et feront partie intégrante de votre endpoint de l’API de personnalisation.
   
   
5. Spécifiez ensuite quelle colonne de votre modèle doit servir d’index principal pour les recherches d’enregistrements. Ce champ doit identifier de manière unique chaque enregistrement de la collection et est souvent identique à la clé primaire de votre modèle. L’API de personnalisation prend en charge les recherches sur plusieurs index. Par exemple, vous souhaiterez peut-être récupérer les profils des clients à l’aide des paramètres user_id, anonymous_id ou email_address. Pour activer plusieurs index, contactez le support Hightouch.
   
   
6. Utilisez le mappeur de champs pour spécifier quelles colonnes de votre modèle doivent être incluses dans la charge utile de la réponse de l’API. Vous pouvez renommer ces champs et utiliser le mappeur avancé pour appliquer des transformations à l’aide du langage de modèle Liquid.
   
   
7. Sélectionnez le comportement de suppression adapté à votre cas d’utilisation.
   
   
8. Enfin, cliquez sur Continuer, puis sélectionnez une planification de synchronisation.

Hightouch synchronise désormais les données de votre entrepôt avec une base de données gérée et les expose via l’API de personnalisation.

Étape 4 : API de personnalisation des appels via Braze Connected Content

Une fois que vous avez configuré votre instance d’API de personnalisation, vous pouvez l’utiliser comme endpoint Braze Connected Content.

L’API est accessible à l’adresse https://personalization.{region}.hightouch.com, par exemple, https://personalization.us-west-2.hightouch.com.

Les informations sont disponibles via cet endpoint /v1/collections/:collection_name/records/:index_key/:index_value.

Par exemple, vous pouvez inclure cet extrait de code dans une campagne ou un 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
%}

Vous pouvez utiliser les modèles Liquid pour référencer les propriétés renvoyées dans la charge utile JSON et les utiliser dans votre envoi de messages.

Pour l’exemple de charge utile ci-dessous :

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

Les références Liquid suivantes renverraient cet exemple de données :

Résolution des problèmes

Si vous avez des questions, contactez le service d’assistance de Hightouch pour obtenir de l’aide.