Disons que vous avez un grand nombre de contacts que vous voulez inscrire en même temps à un parcours. Pour ce faire, vous devez utiliser la fonction batchtrigger de l'API Symplify REST.
Veuillez noter que cette fonction n'est prévue que pour les cas où vous avez un certain nombre de contacts à saisir en même temps ; cette fonction n'est pas destinée à être utilisée pour saisir des contacts individuels pour un parcours. Pour ce faire, veuillez utiliser la requête API simple.
Prérequis
La fonction "Batch Journey Starter" nécessite un fichier d'entrée avec des lignes JSON représentant chaque contact individuel à ajouter au parcours:
{"id": "0", "properties": {"emailAddress": "the_boss@example.com", "firstname": "Bruce", "attributeName": "yes"}}
{"id": "1", "properties": {"emailAddress": "aretha.f@example.com", "firstname": "Aretha", "attributeName": "yes"}}
{"id": "2", "properties": {"emailAddress": "ladygaga@example.com", "firstname": "Lady", "attributeName": "no"}}
NOTE : Chaque ligne du fichier d'entrée doit être un objet JSON distinct. N'utilisez PAS de tableau JSON.
L'attribut "id" de chaque objet JSON dans le fichier représente l'identifiant du contact dans votre système (original ID). L'attribut "properties" peut être utilisé pour fournir des données supplémentaires à chaque contact pour utilisation, par exemple dans des segments ou des placeholders.
Le fichier de contact peut être fourni à Symplify de deux manières différentes : Symplify peut télécharger le fichier à partir d'un URI spécifié, ou il peut être accepté comme PUT vers un URI présigné reçu de l'API Symplify. Vous commencerez par utiliser un POST https://<server>.symplify.com/rest/{customerid}/batchtrigger/v2, et la requête sera différente selon l'approche que vous utiliserez.
Télécharger le fichier sur Symplify
Envoyez la requête suivante par POST :
{
"type": "JOURNEY_COMMENCE",
"entityId": <id of the Journey to commence>
}
La réponse indiquera un URL où télécharger le fichier de contact :
{
"uploadUrl": "https://symplify-batchtrigger.s3.eu-central-1.amazonaws.com/uploads/www4/70225847284177e6bbda5780166c781987bcd1b37695bddd8d1f754066d7fa7e94ffdf9bcae267?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190920T172612Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=43200&X-Amz-Credential=AKIAJNJRZJQCQ3W66YIQ%2F20190920%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Signature=ba9fed3c4eef3ac6b6eb768f74ac4f287d54207a0f67db12e4e0c24e145230b9",
"status": "WAITING_FOR_UPLOAD"
}
Vous pouvez maintenant télécharger le fichier de contact en utilisant un PUT vers l'URL de téléchargement spécifiée dans la réponse. Le lot commencera dans les secondes qui suivent le téléchargement du fichier.
Veuillez noter :
- La valeur de l'entête Content-Type devrait être text/plain
- Le fichier téléversé doit être encodé en UTF-8
- Le uploadUrl sera valide pendant 12 heures
Spécifier un URL de téléchargement pour Symplify
Envoyez la requête suivante par POST :
{
"type": "JOURNEY_COMMENCE",
"entityId": <Id of the Journey to commence>,
"downloadUrl": "https://download.example.com/contacts.txt?signature?abc123"
}
Symplify téléchargera immédiatement le fichier et démarrera le lot. Notez que le fichier doit être publiquement disponible pour le téléchargement. Pour cette raison, il est recommandé de le protéger à l'aide d'une signature temporelle sécurisée.