API Import de Liste

Vous pourriez avoir besoin d'importer des contacts et des données diverses dans Symplify. Pour commencer, une connaissance de base de la gestion des listes et des contacts de Symplify est nécessaire. On suppose que les lecteurs ont une certaine familiarité avec l'interface graphique de Symplify.

​Flux de travail général

Pour démarrer une importation, vous devez préparer un fichier. Symplify utilise du texte brut [1] comme entrée. Si vos destinataires sont enregistrés dans un document Excel, vous devez enregistrer les données sous forme de txt. Les informations dans le fichier doivent être stockées sous forme de tableau délimité par une virgule, une tabulation ou tout autre caractère approprié. Dans Symplifier, sous Paramètres du compte > Attributs des destinataires (Audience), vous pouvez gérer la manière dont les champs du fichier sont mappés aux propriétés de vos contacts.

Une fois le fichier préparé, il est temps de faire la première demande à l'API. Vous aurez besoin de quatre choses pour cette requête :

  • ​L'ID de la liste dans Symplify où vous voulez enregistrer vos contacts.
  • La valeur ASCII du délimiteur utilisé dans le fichier.
  • L'encodage du fichier.
  • Le type d'importation que vous voulez exécuter.

Il existe trois types d’importations:

  • Ajouter : ajoute tous les contacts de votre fichier à la liste existante
  • Remplacer : remplace tous les contacts de la liste par ceux de votre fichier
  • Désabonnement : définir tous les contacts qui ont des lignes correspondantes dans le fichier comme étant désabonnés

​Après avoir recueilli tous ces renseignements, il est temps de faire la demande. La réponse, si tout s'est bien passé, contiendra un identifiant unique qui sera utilisé plus tard.
Pour démarrer l'importation, une requête POST avec des métadonnées décrivant l'importation est envoyée :

POST <server>/rest/<customerId>/lists/<listId>/imports
{
“delimiter”: “9”,
“encoding”: “UTF8”,
“type”: “REPLACE”
}

Exemple de corps de réponse

{“id”: “bd48b5cc-b118-4062-8d06-09efa765592b”}

Il existe une fonction spéciale qui peut être activée dans l'étape décrite ci-dessus. Cette fonctionnalité s'appelle Colonne d'identité et vous permet de spécifier comment les champs de votre fichier sont mis en correspondance avec l'identité des contacts dans Symplify. Normalement, vous devrez fournir une colonne avec un identifiant unique (appelé originalId dans Symplify). Il peut s'agir d'un numéro de ligne, d'une clé primaire, d'un numéro de client ou d'un autre élément qui identifie ce contact de manière unique. Si vous ne pouvez pas fournir une colonne de ce type, vous pouvez utiliser l'adresse email, le numéro de téléphone portable ou toute autre colonne de votre fichier comme identifiant. Voici un exemple d'utilisation de cette fonctionnalité :

POST <server>/rest/<customerId>/lists/<listId>/imports
{
“delimiter”: “9”,
“encoding”: “UTF8”,
“type”: “REPLACE”,
“identityColumn”: “emailaddress”
}

Après que la demande initiale ait été faite et qu'un identifiant ait été renvoyé, il est temps de télécharger vos données. Utilisez l'identifiant obtenu dans la réponse à la première demande pour télécharger vos données :

​POST <server>/rest/<customerId>/lists/<listId>/recipients/<id>
CONTENT-TYPE: text/csv
<data from file>

Exemple de corps de réponse

{“batchId”: “101111”}

​Lorsque le fichier a été téléchargé avec succès, vous pouvez interroger l'API pour suivre la progression des importations. Utilisez le batchId de la requête précédente. Vous pouvez continuer à interroger la méthode jusqu'à ce que vous receviez une réponse avec le statut "FINISHED". N'interrogez pas trop souvent, car cela mettrait une pression inutile sur le système. Une interrogation toutes les 30 secondes ou toutes les minutes est normalement suffisante.

GET <server>/rest/<customerId>/batches/<batchId>

Corps de réponse

{
“id”: 101111,
“type”: “IMPORT”,
“customerId”: 0,
“startTime”: 1394636797030,
“endTime”: 1394636799710,
“affected”: 500,
“processed”: 500,
“total”: 501,
“status”: “ PENDING|IN_PROGRESS|FINISHED“
}

 

------

[1] UTF8, UTF16, ISO-8859-1, ANSI sont également pris en charge.

Cet article vous a-t-il été utile?
Utilisateurs qui ont trouvé cela utile : 0 sur 0