Il est de la responsabilité des clients de s’assurer que leur utilisation de la fonctionnalité Intégrations AJO et des fournisseurs tiers ou intégrations associés est conforme à toutes les lois et réglementations applicables, telles que la loi HIPAA.
Navigation rapide quick-navigation
Utilisez ces liens groupés pour accéder rapidement au modèle de fournisseur approprié :
- Système de gestion de contenu : Contentful, Sitecore, Salsify, Contentstack, Akeneo, Magnolia
- Fidélité et récompenses : Voucherify, Talon.One, Antavo, Fidélité Salesforce, Capillaire
- Modèles, personnalisation et recommandations : Stensul, Marigold, Adobe Target Recommendations
- Données, météo et opérations : AccuWeather, ShipStation, RevenueCat, Databricks
- Examens, consentement et réseaux sociaux : Bynder, Trustpilot, Bazaarvoice, OneTrust, Meta, Aprimo, Epsilon (Epsilon3)
Contenu et CMS content-and-cms
Content contentful
Contentful est un CMS découplé pour les entrées structurées et les ressources sur REST ou GraphQL, de sorte que Journey Optimizer puisse extraire du contenu au moment de l’envoi ou de l’ouverture.
Les cas d’utilisation standard incluent des blocs principaux localisés, du texte de remplacement et des CTA dans des e-mails, ainsi que des entrées de produit ou de promotion dans des modules dynamiques. Une autre tendance courante consiste à récupérer une entrée spécifique par ID pour les messages personnalisés.
Les prérequis suivants sont requis :
- Espace contenu avec accès à l’API de diffusion et clé API orientée lecture.
- Effacer les types de contenu et les identifiants de champ ; accès administrateur dans Journey Optimizer pour créer des intégrations.
Les restrictions et exclusions suivantes s’appliquent :
- Les API Contentful paginées ou à liste large conviennent mal à ce modèle ; préférez les appels de récupération qui ciblent une entrée ou une ressource spécifique.
- L’écriture différée ou la synchronisation bidirectionnelle ne font pas partie de cet exemple.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Configurez GET avec l’API de diffusion de contenu et votre jeton de diffusion, collez l’exemple JSON, mappez les champs, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’URL de l’API de diffusion de contenu (CDA)
https://cdn.contentful.com/spaces/{space_id}/environments/{environment_id}/entries/{entry_id} -
Sélectionnez la méthode HTTP : GET.
-
Ajoutez une authentification. Définissez le paramètre
access_tokenrequête sur votre jeton API de diffusion de contenu, comme illustré dans Exemples de champs d’intégration ci-dessous. Contentful accepte également le même jeton dans un en-têteAuthorization: Bearer; utilisez la prise en charge de vos champs d’intégration quelle qu’elle soit. -
Ajoutez des variables de chemin d’accès si nécessaire (par exemple, ID d’entrée, paramètre régional).
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation.
-
Configurez le délai d’expiration et la mise en cache selon vos besoins.
-
Tester la connexion et activer.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemples de champs d’intégration (alignez-vous sur l’API de diffusion de contenu pour votre espace et votre environnement) :
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://cdn.contentful.com/spaces/{{spaceID}}/environments/{{environment_id}}/entries/{{entry_id}} |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
| Stratégie | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Méthode HTTP | GET |
Paramètres de chemin
| table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
spaceID |
spaceID |
<YOUR_SPACE_ID> |
environment_id |
environment_id |
<YOUR_ENV_ID> |
entry_id |
entry_id |
<YOUR_ENTRY_ID> |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | access_token |
<YOUR_API_KEY> |
Paramètre de requête |
Sitecore sitecore
Sitecore Content Hub et les API cloud associées prennent en charge les flux de métadonnées et de téléchargement de type gestion des ressources numériques. L’exemple de modèle ci-dessous est centré sur un identifiant d’ordre de téléchargement.
Les cas d’utilisation standard incluent les métadonnées de ressource ou de téléchargement dans le contenu des e-mails et l’alignement sur les workflows de gestion des ressources numériques gérés dans Sitecore.
Les prérequis suivants sont requis :
- URL et informations d’identification du client (porteur ou jeton selon votre surface API).
- Accès administrateur dans Journey Optimizer pour la création d’intégrations.
Les restrictions et exclusions suivantes s’appliquent :
- Les noms d’hôtes et les chemins varient selon le produit Sitecore. Utilisez uniquement les points d’entrée exposés par votre client.
- Les jetons d’accès OAuth, l’actualisation et les durées de vie doivent respecter la politique de sécurité de Sitecore.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Configurez GET sur votre chemin d’accès d’ordre de téléchargement, définissez les en-têtes d’autorisation par Sitecore, mappez les
idà partir du contexte, collez l’exemple JSON, mappez les champs et ajustez les délais d’expiration pour la latence des ressources. -
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API Content Hub (exemple : télécharger l’ordre par ID). Exemple de modèle d’URL :
https://xmapps-api.sitecorecloud.io/api/v1/downloadorders/{id} -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Utilisez les champs suivants lorsque vous configurez cet exemple d’appel dans Journey Optimizer. Confirmez le nom d’hôte et la version de l’API pour votre produit (Content Hub, XM Cloud, etc.) dans la documentation de Sitecore.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://xmapps-api.sitecorecloud.io/api/v1/downloadorders/{{id}} |
| Méthode HTTP | GET |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
| Stratégie | Configurez les détails au niveau de la politique en fonction de vos besoins. |
Paramètres de chemin
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
id |
id |
<id_of_download_order> |
En-têtes
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
| Autorisation | Autorisation | Constant | <token> du porteur |
Oui (activé) |
| If-Modified-Since | If-Modified-Since | Variable | 2019-08-:15:22Z | Non (désactivé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | X-Auth-Token | <token> |
Header |
Salsifier salsify
Salsify est un PIM avec des API pour les produits, les canaux et les ressources numériques.
Les cas d’utilisation standard incluent les attributs de produit ou les URL de médias dans les e-mails et les messages alignés sur les données de catalogue syndiquées.
Les prérequis suivants sont requis :
- Jeton API et contexte de l’organisation ; ID de produit résolvables à partir du profil ou du contexte.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Catalogues très volumineux : évitez les points d’entrée de liste en bloc si les intégrations s’attendent à une récupération par entité.
- La visibilité des attributs peut être limitée par les autorisations des rôles Salsify.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Préférez la récupération d’un seul produit aux appels de catalogue en bloc, définissez l’authentification du porteur, collez l’exemple JSON, mappez les champs, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API du produit Salsify. Exemple de modèle d’URL :
https://api.salsify.com/v1/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Certaines références plus anciennes ont réutilisé un chemin de style d’ordre de téléchargement pour Salsify ; votre client peut plutôt utiliser https://app.salsify.com/api/v1/orgs/{org_id}/products/{salsify_id} ou un chemin similaire. Confirmez dans Développement Salsify.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://app.salsify.com/api/v1/orgs/{{org_id}}/products/{{salsify_id}} |
| Méthode HTTP | GET |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
Paramètres de chemin
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
org_id |
org_id |
<org_id> |
salsify_id |
salsify_id |
<salsify_id> |
En-têtes
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (paramètre par défaut) | Content-Type | Constant | application/json | Oui (activé) |
| Autorisation | Autorisation | Constant | Bearer <YOUR_TOKEN_HERE> |
Oui (activé) |
| If-Modified-Since | If-Modified-Since | Variable | 2019-08-:15:22Z | Non (désactivé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | apiKey |
<your_api_key> |
Header |
Contentstack contentstack
Contentstack est un CMS découplé ; la diffusion REST est typique du mappage de champs JSON dans Journey Optimizer.
Un cas d’utilisation type consiste à utiliser des entrées pour des bannières ou des promotions avec des paramètres qui incluent le paramètre régional.
Les prérequis suivants sont requis :
- Clé API de pile, jeton de diffusion, nom d’environnement et UID de type de contenu.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Ce modèle utilise le format JSON REST pour le mappage des champs ; la diffusion GraphQL suit un chemin d’intégration différent.
- Utilisez des jetons de diffusion appropriés pour la production ; les flux de prévisualisation et de publication ne sont pas interchangeables.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Ajoutez des en-têtes
api_keyetaccess_tokencomme Contentstack l’exige, incluez le paramètre de requêteenvironment, collez un exemple de code JSON, mappez des champs, testez et activez. -
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API de diffusion de contenu. Exemple de modèle d’URL :
https://cdn.contentstack.io/v3/content_types/{content_type_uid}/entries/{entry_uid} -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemples de champs d’intégration. Voir API de diffusion de contenu Contentstack.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://cdn.contentstack.io/v3/content_types/{{content_type_uid}}/entries/{{entry_uid}} |
| Méthode HTTP | GET |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
| Stratégie | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| En-têtes | Aucun en-tête supplémentaire nécessaire. |
Paramètres de chemin
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
content_type_uid |
Type de contenu UID | <your_content_type_uid> |
entry_uid |
UID d’entrée | <your_entry_uid> |
Authentification
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Nom de la clé | Valeur de clé | Ajouter à |
api_key |
<YOUR_STACK_API_KEY> |
Header |
access_token |
<YOUR_DELIVERY_TOKEN> |
Header |
Contentstack attend les deux clés comme en-têtes pour les demandes de diffusion.
Paramètres de requête
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
environment |
Nom de l’environnement | Variable | <your_environment_name> |
Oui (activé) |
Akeneo akeneo
Akeneo PIM expose les API REST pour les produits, les attributs et les médias.
Les cas d’utilisation standard incluent les données de produit régies dans les modules d’e-mail et les attributs pour un canal donné dans les parcours.
Les prérequis suivants sont requis :
- URL de base PIM et client OAuth ; UUID de produit ou stratégie d’identifiant.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Les réponses PIM peuvent être volumineuses. Mappez uniquement les attributs requis pour la personnalisation.
- Les opérations d’écriture se situent en dehors des exemples de personnalisation en lecture seule standard.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Utilisez GET avec le jeton porteur, demandez uniquement les options d’attribut nécessaires dans les indicateurs de requête, collez l’exemple JSON, mappez un jeu d’attributs minimal, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API REST Akeneo. Exemple de modèle d’URL :
https://{pim-host}/api/rest/v1/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemple de modèle : https://{pim-host}/api/rest/v1/products-uuid/{uuid} avec Accept: application/json. Voir API Akeneo .
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://{{your-akeneo-domain}}.com/api/rest/v1/products-uuid/{{uuidProduct}} |
| Méthode HTTP | GET |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
Paramètres de chemin
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
uuidProduct |
UUID | <product_uuid> |
En-têtes
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Autorisation | Autorisation | Constant | Bearer <YOUR_TOKEN> |
Oui (activé) |
| Accept | Accept | Constant | application/json | Oui (activé) |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
with_attribute_options |
Inclure les options d’attribut | Variable | False | Non (désactivé) |
with_quality_scores |
Inclure les scores de qualité | Variable | False | Non (désactivé) |
with_completenesses |
Inclure les éléments complets | Variable | False | Non (désactivé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | Autorisation | Bearer <YOUR_ACCESS_TOKEN> |
Header |
Magnolia magnolia
Magnolia offre des points d’entrée de diffusion découplés et REST en fonction du déploiement.
Un cas d’utilisation type consiste à diffuser des nœuds de contenu ou des fragments pour les modules marketing.
Les prérequis suivants sont requis :
- URL de l’instance et jeton ou authentification de base ; espace de travail et chemins de diffusion.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Les URL de diffusion REST dépendent des modules et de la configuration Magnolia installés.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Utilisez le modèle d’URL de diffusion publique que vos modules exposent, authentifiez selon les conseils de Magnolia (diffusion anonyme par rapport au jeton pour le contenu protégé), collez un exemple de JSON, mappez des champs, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide du REST Magnolia (diffusion). Exemple de modèle d’URL :
https://{author-or-public}/.rest/delivery/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemple de modèle : URL de type tour de diffusion https://{domain}/magnoliaAuthor/.rest/delivery/... ou publique. Vos chemins d’accès dépendent des modules installés. Voir la documentation Magnolia.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | http://{{your-domain}}/magnoliaAuthor/.rest/delivery/<myEndpoint>/travel/@nodes |
| Méthode HTTP | GET |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
En-têtes
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Content-Type | Content-Type | Constant | application/json | Oui (activé) |
| Accept | Accept | Constant | application/json | Oui (activé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | Autorisation | <bearer_token> |
Header |
Remarque : l’API de diffusion doit utiliser le rôle rest-anonyme pour le contenu qui ne nécessite pas de connexion. Pour un accès sécurisé aux données protégées, une méthode plus robuste telle que les jetons API ou OAuth 2.0 est préférable.
Fidélité et récompenses loyalty-and-rewards
Voucherify voucherify
Voucherify fournit des API REST de promotion et de fidélité (campagnes, bons, programmes de fidélité).
Les cas d’utilisation standard incluent la lecture de l’état de fidélité ou de promotion des offres dans le contenu et l’affichage du niveau ou de la balance le cas échéant.
Les prérequis suivants sont requis :
- Identifiant et secret de l’application (par région/cluster) ; clarté sur les points d’entrée de fidélité ou de campagne que vous appelez.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Évitez d’exposer les identifiants de promotion ou de campagne internes dans les erreurs rencontrées par le client ou la cliente ou le contenu du message.
- Des limites tarifaires au niveau de l’application s’appliquent. Configurez les reprises et la mise en cache selon les conseils de Bons.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Définissez l’URL de base de votre cluster, ajoutez les en-têtes requis (
X-APP-ID,X-APP-TOKEN), limitez les points d’entrée de liste avec des filtres ou des identifiants, collez un exemple de JSON, mappez des champs, testez, activez. -
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide des API REST/Loyalty. Par Voucherify, définissez l’hôte cluster et les chemins d’accès pour votre région. Exemple de modèle d’URL :
https://{cluster}.voucherify.io/ -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemples de champs d’intégration. Référence complète : API Voucherify.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://{{cluster}}.voucherify.io/v1/loyalties/{{campaignId}}/members |
| Méthode HTTP | GET |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
| Stratégie | Configurez les détails au niveau de la politique en fonction de vos besoins. |
Paramètres de chemin
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
cluster |
cluster |
<your_cluster> |
campaignId |
campaignId |
<loyalty_campaign_Id> |
En-têtes
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
| X-APP-ID | X-APP-ID | Constant | <YOUR-APP-ID> |
Oui (activé) |
| X-Voucherify-Channel | X-Voucherify-Channel | Constant | Documentation de la confirmation | Non (désactivé) |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 5-row-5 6-row-5 7-row-5 8-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
limit |
limit |
Variable | 10 | Non (désactivé) |
page |
page |
Variable | 1 | Non (désactivé) |
customer |
customer |
Variable | <customer_identifier> |
Non (désactivé) |
created_at |
created_at |
Variable | <iso8601_date> |
Non (désactivé) |
updated_at |
updated_at |
Variable | <iso8601_date> |
Non (désactivé) |
order |
order |
Variable | <sort_field> |
Non (désactivé) |
code |
code |
Variable | <loyalty_card_code> |
Non (désactivé) |
ids |
ids |
Variable | <array_of_ids> |
Non (désactivé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | X-APP-TOKEN | <YOUR-APP-TOKEN> |
Header |
Talon.One talon-one
Talon.One est un moteur de règles de promotion et de fidélité qui comprend des API REST pour les sessions, les effets et les profils.
Les cas d’utilisation standard incluent des promotions au niveau du panier ou du profil dans du contenu personnalisé et une progression de la fidélité ou un affichage de récompenses.
Les prérequis suivants sont requis :
- Clé API et URL de base spécifique au déploiement ; identifiants de la portée de l’application ou de la campagne.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Les flux de sessions volumineux peuvent nécessiter un mappage soigneux au modèle de requête d’intégration .
- Observez les limites de taux de Talon.One et les conseils d’idempotence.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Utilisez GET sur le profil ou le chemin d’accès dont vous avez besoin, définissez les
Authorization: ApiKey-v1 <key>comme documenté, collez un exemple de JSON, mappez des champs, testez, activez. -
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API d’intégration Talon.One. Exemple de modèle d’URL :
https://{your-domain}.talon.one/v1/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
| table 0-row-2 1-row-2 2-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://{{your-deployment}}.talon.one/v1/customer_profiles/{{integrationId}}/achievements/{{achievementId}} |
| Méthode HTTP | GET |
Paramètres de chemin
| table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
your-deployment |
your-deployment |
<your_deployment> |
integrationId |
integrationId |
<integrationId> |
achievementId |
achievementId |
<achievementId> |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 5-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
progressStatus |
progressStatus |
Variable | en cours / terminé / expiré | Non (désactivé) |
startDate |
startDate |
Variable | 2024-05-:04:05+07:00 | Non (désactivé) |
endDate |
endDate |
Variable | 2024-05-:04:05+07:00 | Non (désactivé) |
pageSize |
pageSize |
Variable | <default_page_size> |
Non (désactivé) |
skip |
skip |
Variable | <items_to_skip> |
Non (désactivé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | Autorisation | <YOUR_API_KEY> ApiKey-v1 |
Header |
Antavo antavo
Antavo est une plateforme de fidélité d’entreprise avec des API REST pour les membres, les récompenses et les événements.
Les cas d’utilisation standard incluent les points, le niveau ou les récompenses dans les e-mails ou les notifications push et les offres pilotées par l’état de fidélité.
Les prérequis suivants sont requis :
- Empilage des identifiants d’URL et d’API ; identifiants de programme ou de boutique selon les besoins.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Les PII des clients doivent être traitées dans le cadre des accords Antavo et de vos politiques de confidentialité.
- Confirmez les versions d’API et les points d’entrée stables avec Antavo pour votre environnement.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Configurez GET avec l’authentification du fournisseur (par exemple, la clé API dans la requête), évitez d’exposer les informations d’identification personnelles dans la politique, collez l’exemple JSON, mappez les champs, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API Antavo Enterprise.
-
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Les exemples de champs d’intégration utilisent l’hôte staging ; la production utilise votre nom d’hôte de pile Antavo. Voir la documentation Antavo.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://api.staging.antavo.com/customers/{{customer_id}}/activities/offers |
| Méthode HTTP | GET |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
Paramètres de chemin
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
customer_id |
customer_id |
<customer_id> |
En-têtes
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
| Accept | Accept | Constant | application/json | Non (désactivé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | api_key |
<YOUR_API_KEY> |
Paramètre de requête |
Fidélité à Salesforce salesforce-loyalty
La gestion de la fidélité Salesforce expose les API REST sur la plateforme Salesforce pour les membres, les programmes et les transactions.
Les cas d’utilisation standard incluent l’affichage du niveau, des points ou des avantages dans les parcours et l’alignement des messages avec les données de gestion de la relation client et de fidélité.
Les prérequis suivants sont requis :
- Instance Salesforce, application connectée ou utilisateur de l’intégration, et OAuth approprié à votre organisation.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Les limites de l’API Salesforce et l’actualisation du jeton OAuth doivent être conçues dans votre intégration.
- Les règles de sécurité et de partage au niveau du champ régissent les champs qui apparaissent dans les réponses de l’API.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Utilisez le point d’entrée d’intégration de fidélité approuvé par votre équipe, exécutez Salesforce OAuth, collez l’exemple JSON, mappez des champs, respectez les limites d’API composites, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide du REST Salesforce Loyalty Management. Exemple de modèle d’URL :
https://{instance}.salesforce.com/services/data/vXX.X/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Utilisez l’opération GET Loyalty Management profil de membre documentée pour la version de l’API de votre organisation. Les chemins incluent le programme et les identifiants des membres. Voir Développeurs .
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://{{your-instance}}.my.salesforce.com/services/data/{{version}}/connect/loyalty/management/members |
| Méthode HTTP | GET |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
Paramètres de chemin
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
your-instance |
your-instance |
<your_instance> |
version |
version |
version |
En-têtes
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
| Accept | Accept | Constant | application/json | Non (désactivé) |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
membershipNumber |
membershipNumber |
Variable | <membership_number> |
Non (désactivé) * |
membershipId |
membershipId |
Variable | <membership_id> |
Non (désactivé) * |
posMemId |
posMemId |
Variable | <pos_mem_id> |
Non (désactivé) * |
* Au moins un des trois est requis.
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | Autorisation | <access_token> |
Header |
Capillaire capillary
Capillary fournit des API de fidélité et d’engagement courantes dans les piles de vente au détail.
Les cas d’utilisation standard incluent des points, des niveaux ou des offres dans des parcours personnalisés.
Les prérequis suivants sont requis :
- Hôte et authentification de l’API (requêtes souvent signées ; suivez la documentation Capillary).
- Identifiants de programme pour votre point d’entrée.
Les restrictions et exclusions suivantes s’appliquent :
- Les schémas d’authentification et les hôtes régionaux varient selon le déploiement. Confirmez avec Capillary pour votre pile.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Configurez des en-têtes tels que
CAP-API-ACCESS-TOKENselon les besoins, collez l’exemple JSON, mappez des champs, testez, activez. -
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide des API Capillary.
-
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemple : https://ushc.intouch.capillarytech.com/api/v3/rewards/{reward_id} (l’hôte varie selon la région). Validez le schéma d’hôte et d’authentification avec Capillaire.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://ushc.intouch.capillarytech.com/api/v3/rewards/{{reward_id}} |
| Méthode HTTP | GET |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
Paramètres de chemin
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
reward_id |
ID de récompense | <your_reward_id> |
En-têtes
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Content-Type | Content-Type | Constant | application/json | Oui (activé) |
| CAP-API-ACCESS-TOKEN | Jeton d’accès | Constant | <YOUR_ACCESS_TOKEN> |
Oui (activé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | CAP-API-ACCESS-TOKEN | <YOUR_ACCESS_TOKEN> |
Header |
Modèles et messages templates-and-messaging
Stensul stensul
Stensul est une plateforme de création d’e-mails pour les modèles approuvés ; Journey Optimizer peut utiliser des métadonnées de modèle et des régions structurées par le biais de son API.
Les cas d’utilisation standard incluent l’importation de modèles approuvés et le mappage de régions à des attributs de profil, ainsi que la réutilisation de blocs régis pour des versions de campagne évolutives.
Les prérequis suivants sont requis :
- Compte Stensul avec accès à l’API et modèles publiés avec jetons définis.
- Accès administrateur dans Journey Optimizer pour la création d’intégrations.
Les restrictions et exclusions suivantes s’appliquent :
- La modification statique par WYSIWYG des modèles Stensul dans Journey Optimizer n’est pas abordée ici.
- HTML volumineux ou complexe dans les payloads de modèle peut nécessiter une révision et une désinfection de la sécurité.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration.
-
Configurez le point d’entrée à l’aide de l’URL de l’API Modèles Stensul . Exemple de modèle d’URL :
https://api.stensul.com/v1/templates/{template_id} -
Configurez l’authentification (clé API ou documentation OAuth par API Stensul).
-
Définir des variables de chemin d’accès , par exemple un identifiant de modèle.
-
Collez un exemple de réponse JSON pour la détection de champ.
-
Mappez les champs de modèle obligatoires aux champs de personnalisation Journey Optimizer.
-
Tester la connexion et activer.
Marigold marigold
Marigold expose les API de fidélité et d’engagement ; les hôtes diffèrent selon la géographie (noms d’hôtes de modules UE et US).
Un cas d’utilisation type consiste à enrichir les messages avec des données de fidélité ou de préférence provenant des programmes Marigold.
Les prérequis suivants sont requis :
- URL de base et informations d’identification provenant de votre contrat ; utilisateur de l’API avec les moindres privilèges lorsque cela est possible.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Les points d’entrée varient selon le produit Marigold. Effectuez la validation avec la prise en charge de Marigold pour votre déploiement.
- Les données personnelles contenues dans les réponses doivent être conformes à votre DPA et à vos politiques de conservation.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Pointez sur l’hôte Marigold pour votre région, définissez l’authentification (l’exemple ci-dessous utilise
X-Api-Keyavec la clé et le secret), collez l’exemple JSON, mappez des champs, testez, activez. -
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API REST Marigold.
-
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
-
Marigold utilise 2 points d’entrée en fonction de la zone géographique pour laquelle l’instance client est active :
- Europe :
https://{{customername}}.module.slgnt.eu - USA :
https://{{customername}}.module.slgnt.us
- Europe :
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
L’hôte de base dépend de la région (par exemple, https://{{customername}}.module.slgnt.eu ou https://{{customername}}.module.slgnt.us). Confirmez les chemins avec Marigold pour votre déploiement.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://{{customername}}.module.slgnt.{{locale}}/Portal/Api/organizations/{{organization}}/content/{{api_name}} |
| Méthode HTTP | GET |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
| Stratégie | Configurez les détails au niveau de la politique en fonction de vos besoins. |
Paramètres de chemin
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
customername |
customername |
<your_name> |
locale |
locale |
eu / us |
organization |
organization |
<your_organization> |
api_name |
api_name |
<api_name> |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | X-Api-Key | <apiKey>:<apiSecret> |
Header |
Recommandations Adobe Target adobe-target-recommendations
Adobe Target comprend des recommandations et des API de diffusion pour les expériences côté serveur ou intégrées, sous réserve des droits.
Les cas d’utilisation standard incluent l’injection de recommandations dans les expériences que vous créez dans Journey Optimizer et l’alignement des clés avec le contexte du profil ou d’Experience Platform.
Les prérequis suivants sont requis :
- Target avec Recommendations ; organisation IMS et authentification prise en charge.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Les API de recommandation et de diffusion nécessitent des paramètres spécifiques (par exemple, des identifiants de mbox ou de produit). Consultez la documentation d’Adobe Target.
- Réglez la latence et la mise en cache pour votre volume d’envoi et votre cas d’utilisation.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Les appels de diffusion sont souvent POST avec un corps JSON. Configurez OAuth par authentification de la cible, collez un exemple de réponse, mappez des champs, testez sous le volume attendu.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide des API Target Recommendations/delivery.
-
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
| table 0-row-2 1-row-2 2-row-2 3-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://{{client}}.tt.omtrdc.net/rest/v1/delivery |
| Stratégie | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Méthode HTTP | POST |
Paramètres de chemin
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
client |
client |
<client_name> |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| client | client | Variable | <customer_client_code> |
Oui (activé) |
| sessionId | sessionId | Variable | <session_identifier> |
Oui (activé) |
Authentification
Reportez-vous à Configuration de l’authentification Target et ajoutez JSON à la payload.
Payload de requête
| code language-sample |
|---|
|
Données, météo et opérations data-weather-and-operations
AccuWeather accuweather
AccuWeather expose les API REST de prévision et d’emplacement afin que les messages puissent inclure des fragments de code prenant en compte la météo.
Les cas d’utilisation standard incluent des prévisions courtes dans les e-mails ou les notifications push, et personnalisent le contenu en utilisant des valeurs de prévision liées au profil ou au contexte.
Les prérequis suivants sont requis :
- Clé et abonnement à l’API ; clé d’emplacement pour un flux de recherche de ville.
- Accès administrateur dans Journey Optimizer pour la création d’intégrations.
Les restrictions et exclusions suivantes s’appliquent :
- Confirmez la forme de réponse JSON pour votre niveau d’abonnement AccuWeather. Les intégrations mappent les champs des réponses JSON.
- Respectez les limites de débit AccuWeather et la mise en cache recommandée.
- La résolution des
locationKeynécessite souvent une géolocalisation distincte ou une requête de recherche de ville avant les appels de prévision.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Utilisez GET à moins que votre abonnement n’en exige autrement, joignez le paramètre de requête
apiKey, mappez leslocationKeyet d’autres variables de profile/context, collez l’exemple JSON, mappez des champs, puis testez. -
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API Daily Forecasts. Exemple de modèle d’URL :
https://dataservice.accuweather.com/forecasts/v1/daily/{days}day/{locationKey} -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemples de champs d’intégration. Les détails et les niveaux sont décrits dans la section API AccuWeather. Vous résolvez souvent les locationKey avec un appel de recherche d’emplacements distinct (par exemple, .../locations/v1/cities/search?q={{cityName}}).
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://dataservice.accuweather.com/forecasts/v1/daily/{{days}}day/{{locationKey}} |
| Méthode HTTP | GET |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
| Stratégie | Configurez les détails au niveau de la politique en fonction de vos besoins. |
Paramètres de chemin
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
days |
days |
15 |
locationKey |
locationKey |
<desired_location_key> |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
format |
format |
Variable | json | Non (désactivé) |
language |
language |
Variable | en-US | Non (désactivé) |
details |
details |
Variable | False | Non (désactivé) |
metric |
metric |
Variable | False | Non (désactivé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | apiKey |
<YOUR_API_KEY> |
Paramètre de requête |
ShipStation shipstation
ShipStation propose des API d’expédition et de commande pour les transporteurs, les étiquettes et le suivi.
Les cas d’utilisation standard incluent le statut de la commande, les liens de suivi ou les ETA de diffusion dans les messages transactionnels.
Les prérequis suivants sont requis :
- Clé API et secret (authentification de base par documents ShipStation).
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- N’exposez pas les clés API ShipStation dans le contenu du message ; conservez uniquement les informations d’identification dans la configuration de l’intégration.
- Les points d’entrée de liste paginés peuvent ne pas convenir aux intégrations ; préférez les GET à ressource unique lorsque cela est possible.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Ciblez la ressource dont vous avez besoin (commandes ou expéditions), authentifiez-la par API ShipStation, collez l’exemple JSON, mappez des champs, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API REST ShipStation. Exemple de modèle d’URL :
https://ssapi.shipstation.com/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
L’exemple suivant Get Timer illustre un appel de minutage d’automatisation ShipStation. Utilisez le chemin d’accès et l’authentification exacts de votre guide d’intégration ShipStation lors de leur reproduction dans Journey Optimizer.
| table 0-row-2 1-row-2 2-row-2 3-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://dashboard.sendtric.com/api/v1/timers/{{id}} |
| Méthode HTTP | POST |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | apiKey | <your_api_key> |
Header |
Payload de requête
| code language-sample |
|---|
|
RevenueCat revenuecat
RevenueCat fournit des API de statut d’abonnement et de droits pour les applications.
Un cas d’utilisation type reflète le statut d’abonnement dans les campagnes de cycle de vie lorsque la politique le permet.
Les prérequis suivants sont requis :
- Clé API secrète et identifiants d’application ; mappage stable entre les profils et les ID client RevenueCat.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Protégez les clés API secrètes et suivez vos politiques de rotation.
- Les données d’abonnement et de droit sont sensibles. Respectez les exigences de confidentialité et de consentement.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Appelez le REST GET modélisé ci-dessous, authentifiez-vous avec l’en-tête de clé secrète, collez l’exemple JSON, mappez les champs, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API REST RevenueCat. Exemple de modèle d’URL :
https://api.revenuecat.com/v1/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemple de modèle : utilisez la méthode Get a Product de RevenueCat (ou une méthode GET de produit/droit équivalente) à partir de la RevenueCat docs avec l’URL de base et la version de votre projet.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://api.revenuecat.com/projects/{{project_id}}/products/{{product_id}} |
| Méthode HTTP | GET |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
Paramètres de chemin
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
project_id |
project_id |
<project_id> |
product_id |
product_id |
<product_id> |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
country |
country |
Variable | <iso_country_code> |
Non (désactivé) |
locale |
locale |
Variable | <locale_code> |
Non (désactivé) |
parentId |
parentId |
Variable | <parent_category_id> |
Non (désactivé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | Autorisation | Bearer <token> |
Header |
Databricks databricks
Databricks fournit des API SQL et REST sur les données d’entrepôt de données ; les brouillons précédents combinaient des conseils d’exécution d’instructions avec un exemple jobs/get.
Un cas d’utilisation type consiste à utiliser de petits attributs dénormalisés provenant de tables gouvernées pour la personnalisation avec les privilèges les plus stricts.
Les prérequis suivants sont requis :
- Hôte Workspace, jeton ou OAuth par politique d’organisation ; principal de service avec portée minimale.
- Accès administrateur dans Journey Optimizer.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Préférez les chemins de lecture étroits. Si vous utilisez l’exécution d’instruction POST, incluez le corps JSON dont l’API a besoin, collez un exemple de réponse de réussite pour le mappage, testez soigneusement la latence, puis activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API d’exécution d’instruction SQL Databricks. Exemple de modèle d’URL :
https://{workspace-host}/api/2.0/sql/statements/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
L’exemple de tâche GET ci-dessous est donné à titre d’illustration. Pour la personnalisation pilotée par SQL, préférez le modèle API d’exécution d’instruction pris en charge par votre espace de travail.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://<databricks-instance>/api/2.0/jobs/get |
| Méthode HTTP | GET |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
| Stratégie | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Authentification | OAuth |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Accept | Accept | Constant | application/json | Oui (activé) |
Paramètres de requête
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
job_id |
job_id |
Variable | 12 |
Oui |
Révisions, consentement et réseaux sociaux reviews-consent-and-social
Bynder bynder
Bynder est une gestion des ressources numériques (DAM) avec des API REST ; les intégrations utilisent généralement OAuth 2.0 pour les métadonnées en lecture seule ou les URL de ressources.
Les cas d’utilisation standard incluent l’extraction de métadonnées de ressource ou d’URL de diffusion dans les messages et la validation des créations dans Bynder en fonction des parcours.
Les prérequis suivants sont requis :
- Domaine de portail et client OAuth (ou approche par jeton approuvée).
- Portées pour l’accès en lecture seule ; accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- La pagination et l’actualisation du jeton OAuth doivent respecter les règles de l’API de Bynder.
- Réponses paginées volumineuses : mappez uniquement les champs requis pour la personnalisation.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Configurez GET sur le point d’entrée choisi (un modèle courant est la liste des utilisateurs), exécutez OAuth par Bynder, évitez d’extraire des pages de données inutiles, mappez des champs, testez, puis activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API Bynder v4. Exemple de modèle d’URL :
https://{your-bynder-domain}/api/v4/users/ -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemples de champs d’intégration. Voir Documentation de l’API Bynder pour obtenir plus d’informations sur la payload OAuth 2.0.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://{{your-bynder-domain}}/api/v4/users/ |
| Méthode HTTP | GET |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
| Stratégie | Configurez les détails au niveau de la politique en fonction de vos besoins. |
Paramètres de chemin
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
your-bynder-domain |
your-bynder-domain |
<your-bynder-domain> |
En-têtes
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
| Autorisation | Autorisation | Constant | <token> du porteur |
Oui (activé) |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
includeInActive |
includeInActive |
Variable | False | Non (désactivé) |
limit |
limit |
Variable | 100 | Non (désactivé) |
page |
page |
Variable | 1 | Non (désactivé) |
Authentification
| table 0-row-2 1-row-2 | |
|---|---|
| Type | Payload |
| OAuth 2.0 | Payload OAuth 2.0 (voir la documentation Bynder) |
| code language-none |
|---|
|
Trustpilot trustpilot
Trustpilot fournit des API pour les données commerciales et de synthèse de révision lorsque votre cas d’utilisation et votre contrat le permettent.
Un cas d’utilisation type affiche le nombre de révisions ou les évaluations dans le contenu marketing conforme aux termes de Trustpilot.
Les prérequis suivants sont requis :
- Clé API et cas pratique approuvé ; identifiants d’entreprise pour les requêtes.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- L’utilisation des données de Trustpilot doit être conforme aux politiques de marque et d’utilisation des données de Trustpilot.
- Des limites de taux s’appliquent au résumé de révision et aux points d’entrée associés.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Configurez GET avec l’authentification de requête requise, mappez les identifiants du profil ou du contexte, collez l’exemple JSON, mappez les champs, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide des API Trustpilot. Exemple de modèle d’URL :
https://api.trustpilot.com/v1/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Utilisez l’opération de liste de catégories de développeurs Trustpilot pour votre modèle d’intégration ; les paramètres varient selon la ressource.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://api.trustpilot.com/v1/categories |
| Méthode HTTP | GET |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
country |
country |
Variable | <iso_country_code> |
Non (désactivé) |
locale |
locale |
Variable | <locale_code> |
Non (désactivé) |
parentId |
parentId |
Variable | <parent_category_id> |
Non (désactivé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | apiKey | <your_api_key> |
Header |
Bazaarvoice bazaarvoice
Bazaarvoice fournit des évaluations, des avis et des API UGC.
Un cas d’utilisation type consiste à afficher des résumés de révision ou des évaluations dans les e-mails lorsque la politique le permet.
Les prérequis suivants sont requis :
- Clé de sécurité API et identifiants client de votre contrat.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- L’affichage des évaluations et des avis doit suivre les politiques de contenu de Bazaarvoice.
- Des limites de débit et des règles de mise en cache s’appliquent par clé API.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Utilisez GET avec
passkeycomme paramètre de requête sur l’API Conversations, définissezAccept: application/json, collez l’exemple JSON, mappez des champs, testez, activez. -
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API Bazaarvoice Conversations. Exemple de modèle d’URL :
https://api.bazaarvoice.com/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemple de point d’entrée : https://api.bazaarvoice.com/data/products.json avec des paramètres de requête de version et de filtre. Voir développeur Bazaarvoice.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://api.bazaarvoice.com/data/products.json |
| Méthode HTTP | GET |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Accept | Accept | Constant | application/json | Oui (activé) |
Authentification
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Type | Valeur de clé | Emplacement |
| mot de passe | <YOUR_ACCESS_TOKEN> |
Paramètre de requête |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
apiversion |
apiversionNumber | Constant | 5.4 | Oui (activé) |
filter |
filter |
Variable | Id :47950830 | Non (désactivé) |
stats |
stats |
Variable | tout | Non (désactivé) |
OneTrust onetrust
OneTrust expose les API de confidentialité et de consentement (URL et schémas spécifiques aux produits).
Un cas d’utilisation type consiste à lire des signaux de consentement ou de préférence pour du contenu conditionnel lorsque l’architecture et la révision juridique le permettent.
Les prérequis suivants sont requis :
- Informations d’identification d’API et URL de base régionale ; approbation légale des champs utilisés dans la messagerie.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Les données relatives au consentement et aux préférences sont très réglementées. Coordonnez-vous avec les équipes juridiques et de confidentialité.
- Les chemins d’accès et les payloads des API diffèrent selon le produit OneTrust. Utilisez la documentation pour votre abonnement.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Utilisez le schéma publié ou le chemin d’accès au centre de préférences de vos documents d’abonnement, renseignez OAuth si nécessaire, collez un exemple de code JSON, mappez des champs, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API OneTrust. Votre client, votre produit et votre chemin d’accès proviennent de la documentation OneTrust de votre abonnement. Exemple de modèle d’URL :
https://{tenant}.my.onetrust.com/api/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://customer.my.onetrust.com/api/consentmanager/v2/preferencecenters/{{preferencecenterid}}/schema |
| Méthode HTTP | GET |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
| Authentification | OAuth |
Paramètres de chemin
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Paramètre | Nom | Valeur |
preferencecenterid |
preferencecenterid |
<pref-id> |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Accept | Accept | Constant | application/json | Oui (activé) |
Paramètres de requête
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
state |
state |
constant | PUBLIÉ | Oui |
Schéma du centre de préférences (publié)
Exemple de modèle (fragment) : https://{tenant}.my.onetrust.com/api/consentmanager/v2/preferencecenters/{preferencecenterid}/schema?state=PUBLISHED. Confirmez le chemin exact dans OneTrust Developer.
Meta meta
Les API Graph et Marketing de Meta exposent les objets de catalogue et de campagne pour les intégrations commerciales autorisées.
Un cas d’utilisation type consiste à enrichir le contenu avec des attributs provenant de Meta, lorsque les jetons et les politiques le permettent.
Les prérequis suivants sont requis :
- Utilisateur système ou jeton d’application avec les autorisations appropriées ; alignement de Business Manager.
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Les jetons d’accès de courte durée nécessitent une stratégie de renouvellement ou de longue durée adaptée aux intégrations côté serveur.
- Respectez les conditions générales de la plateforme Meta ; ne consignez pas de jetons ou d’autres secrets dans les payloads des messages.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Les appels graphiques sont souvent GET avec un chemin versionné. Gérez l’expiration des jetons, collez un exemple de JSON, mappez des champs, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API Meta Graph. Exemple de modèle d’URL :
https://graph.facebook.com/vXX.X/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemples de champs d’intégration. Voir API Graph pour le contrôle de version et les jetons d’accès.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://graph.facebook.com/{{API_VERSION}}/{{PRODUCT_CATALOG_ID}}/products |
| Méthode HTTP | GET |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
| Stratégie | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Authentification | OAuth |
Paramètres de chemin
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
API_VERSION |
API_VERSION |
v19.0 |
PRODUCT_CATALOG_ID |
PRODUCT_CATALOG_ID |
12345 |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Accept | Accept | Constant | application/json | Oui (activé) |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
fields |
fields |
Variable | identifiant | Non |
filter |
filter |
Variable | — | Non |
Aprimo aprimo
Aprimo combine des opérations marketing et des API de gestion des ressources numériques pour les enregistrements, les ressources et les métadonnées.
Les cas d’utilisation standard incluent les champs d’enregistrement ou de ressource approuvés dans le contenu dynamique et les workflows de gestion des ressources numériques régis dans les secteurs réglementés.
Les prérequis suivants sont requis :
- URL et informations d’identification du client (OAuth ou clé API selon votre configuration).
- Accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- La sécurité au niveau du champ Aprimo doit s’aligner sur les attributs que vous mappez dans Journey Optimizer.
- Payloads HAL ou JSON volumineuses : limitez les champs mappés à l’ensemble minimum requis.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Utilisez GET sur le chemin d’enregistrement dont vous avez besoin, envoyez les en-têtes requis tels que
API-VERSION, collez l’exemple JSON (HAL ou JSON tel que renvoyé), mappez un ensemble de champs minimal, testez, activez. -
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API Enregistrements / DAM Aprimo. Utilisez l’URL de base de l’API et le chemin d’accès aux enregistrements pour votre client (selon Aprimo). Exemple de modèle d’URL :
https://{tenant}.dam.aprimo.com/ -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
| table 0-row-2 1-row-2 2-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://productstrategy1.dam.aprimo.com/api/core/record/{{recordID}} |
| Méthode HTTP | GET |
Paramètres de chemin
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
recordId |
recordId |
<record_identifier> |
En-têtes
| table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 5-row-5 6-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
| API-VERSION | API-VERSION | Constant | 1 | Oui (activé) |
| Accept | Accept | Constant | application/hal+json OU application/json | Non (désactivé) |
| select-record | select-record | Variable | <selection_type> |
Non (désactivé) |
| select-record-fields | select-record-fields | Variable | <field_list> |
Non (désactivé) |
| select-field | select-field | Variable | <field_selection> |
Non (désactivé) |
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | Autorisation | <token> du porteur |
Header |
Epsilon (Epsilon3) epsilon
Epsilon expose les API par contrat d’entreprise ; les URL de base et les authentifications proviennent de votre équipe de compte (l’exemple d’API d’événements ci-dessous est illustratif).
Un cas d’utilisation type expose les attributs de fidélité ou d’offre par le biais d’API JSON prises en charge.
Les prérequis suivants sont requis :
- Informations d’identification et points d’entrée d’Epsilon ; accès administrateur dans Journey Optimizer.
Les restrictions et exclusions suivantes s’appliquent :
- Les points d’entrée et les hôtes sont spécifiques au client. Ne déployez pas sans la documentation de l’équipe de votre compte Epsilon.
Suivez la procédure ci-dessous pour configurer cette intégration dans Journey Optimizer. Voir Exemples de champs d’intégration par exemple les détails de la demande et confirmer ces valeurs avec la documentation du fournisseur pour votre environnement.
-
Suivez Utilisation des intégrations. Ne devinez pas les URL publiques. Utilisez la spécification Epsilon, collez l’exemple JSON, mappez les champs, testez, activez.
-
Dans Journey Optimizer, accédez à Configurations > Gérer, puis sélectionnez Créer une intégration.
-
Saisissez un nom d’intégration sans espaces.
-
Configurez le point d’entrée à l’aide de l’API Epsilon (conformément à votre spécification d’intégration). L’URL de base et les chemins d’accès aux ressources sont fournis par l’équipe de votre compte Epsilon. Exemple de modèle d’URL :
https://{your-instance}.epsilon3.io/api/... -
Sélectionnez la méthode HTTP affichée dans le tableau de configuration, généralement GET, sauf indication contraire.
-
Configurez l’authentification (en-têtes, paramètres de requête ou OAuth) exactement comme spécifié dans le tableau et dans la documentation du fournisseur.
-
Définissez les paramètres de chemin, de requête et d’en-tête, et mappez les variables aux données de profil ou contextuelles, si nécessaire.
-
Collez un exemple de réponse JSON afin que les champs puissent être détectés et mappés.
-
Sélectionnez les champs requis pour la personnalisation dans le mappage de la payload de réponse.
-
Configurez les politiques de temporisation, de reprise et de mise en cache en fonction du volume attendu.
-
Testez la connexion, puis activez l’intégration.
Le tableau ci-dessous répertorie les exemples de valeurs pour cette demande d’intégration.
Exemple de modèle : https://{your-instance}.epsilon3.io/api/v1/planning/events avec des paramètres de requête start et end et une clé API basée sur l’en-tête . Confirmez avec Epsilon avant la production.
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| Champ | Valeur |
| URL | https://{{your-instance}}.epsilon3.io/api/v1/planning/events |
| Méthode HTTP | GET |
| Politique | Configurez les détails au niveau de la politique en fonction de vos besoins. |
| Payload de réponse | Sélectionnez et configurez les champs de réponse souhaités à utiliser lors de la création, en fonction de la réponse de l’API. |
Paramètres de chemin
| table 0-row-3 1-row-3 | ||
|---|---|---|
| Paramètre de chemin | Nom | Valeur par défaut |
your-instance |
your-instance |
<your_instance> |
En-têtes
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
| Type de contenu (par défaut) | Content-Type | Constant | application/json | Oui (activé) |
Paramètres de requête
| table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 | ||||
|---|---|---|---|---|
| Paramètre | Nom | Type | Valeur | Obligatoire |
start |
start |
Variable | 2019-08-:15:22Z | Oui (activé) * |
end |
end |
Variable | 2019-08-:15:22Z | Oui (activé) * |
eventType |
eventType |
Variable | planifié/non planifié | Non (désactivé) |
exclude_recurrences |
exclude_recurrences |
Variable | true/false | Non (désactivé) |
* Facultatif pour eventType = unscheduled et pour exclude_recurrences = true.
Authentification
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| Type | Nom de la clé API | Valeur de clé API | Emplacement |
| Clé API | <your_username> |
<EPSILON3_API_KEY> |
Header |