Sources de données et API

Comment envoyer des enregistrements vers une source de données avec l'API Sendtric

Dernière mise à jour

Avec une source de données API, ton système envoie des enregistrements JSON à Sendtric dès que tes données changent. Sendtric les stocke sous forme de données hébergées, et tes images récupèrent l'enregistrement de chaque abonné lorsqu'un e-mail est ouvert.

Ce guide s'adresse à tous ceux qui écrivent le code permettant d'envoyer les données. Si tu préfères que Sendtric récupère les données depuis ton API à chaque ouverture, consulte comment connecter une source de données à ta propre API.

Créer la source de données

  1. Dans la barre latérale de gauche, clique sur Sources de données, puis Nouvelle source de données.
  2. Sous API, choisis API et clique sur Continuer.
  3. Choisis Envoyer les données à Sendtric puis clique sur Continuer.
  4. Remplis :
    • Nom de la source de données: par exemple « Membres du programme de fidélité ».
    • Champ d'identifiant unique: le champ JSON qui identifie chaque enregistrement, comme customer_id ou email. Chaque enregistrement que tu envoies doit le contenir.
    • Description (facultatif).
  5. Clique sur Enregistrer la source de données. La source de données est créée et l' étape « API » affiche tes points de terminaison et ta clé API.
  6. Copie ce dont tu as besoin, puis clique sur Continuer pour terminer.
La section « API » d'une nouvelle source de données, qui présente les points de terminaison pour l'upsert d'un seul enregistrement et l'upsert en masse, la clé API et des exemples de requêtes

Tu peux retrouver ces points de terminaison à tout moment dans la section onglet « Détails de l'API » de la source de données.

Se connecter

Envoie ta clé dans l' Authorization en-tête de chaque requête :

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

La clé API de la source de données ne sert qu’à envoyer des enregistrements de source de données ; tu peux donc la communiquer en toute sécurité à un développeur ou à un outil d’automatisation. Si tu as souscrit à une formule API, ta clé API existante fonctionne également sur ces points de terminaison.

Ne mets pas ta clé dans le code frontal ni dans les dépôts publics. Si jamais elle venait à être exposée, régénère-la sous Paramètres → Clés API → Clé API de la source de données, puis mets à jour tout ce qui l'utilise.

Créer ou mettre à jour des fiches

ENVOIE un objet JSON unique ou un tableau d'objets vers le point de terminaison indiqué dans Sendtric. Un enregistrement :

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "customer_id": "CUST_1001",
  "first_name": "Sarah",
  "points": 1250
}

Plusieurs enregistrements dans une seule requête :

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

[
  { "customer_id": "CUST_1001", "first_name": "Sarah", "points": 1250 },
  { "customer_id": "CUST_1002", "first_name": "James", "points": 300 }
]

Comment les données sont enregistrées :

  • Si aucun enregistrement ne porte encore cet identifiant, un nouvel enregistrement est créé.
  • Si c'est le cas, c'est remplacé par ce que tu as envoyé. Les champs que tu ne remplis pas sont supprimés, alors envoie toujours l'enregistrement complet.
  • Les nouvelles données et celles mises à jour sont généralement disponibles en une minute environ.
  • La correspondance des identifiants ne tient pas compte de la distinction entre majuscules et minuscules.

Une requête réussie renvoie 200 un bref résumé, par exemple {"status":"ok","records":2}.

Tu peux imbriquer des objets dans un enregistrement, par exemple "address": { "city": "Leeds" }, et sélectionner des champs imbriqués dans l'éditeur d'images.

Supprimer des enregistrements

Pour supprimer un enregistrement, ajoute son identifiant à la fin de l'URL :

DELETE <your data source endpoint>/cust_1001
Authorization: Bearer YOUR_API_KEY

Pour en supprimer plusieurs, envoie un tableau d'identifiants :

DELETE <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

["cust_1001", "cust_1002"]

Limites

LimiteValeur
Nombre d'enregistrements par requête10 000
Taille de la requête10 Mo
Valeur de l'identifiant255 caractères
N'importe quelle valeur textuelle10 Ko
Profondeur d'imbrication20 niveaux

Envoie les enregistrements par lots plutôt que d'envoyer une requête par enregistrement. Pour des milliers d'enregistrements, consulte comment envoyer de grandes quantités de données vers une source de données.

Réponses et erreurs

StatutCe que ça veut direQue faire ?
200Fiches acceptéesRien. Si certains enregistrements ont été ignorés, l'en-tête « X-Skipped-Records » indique combien
400Le corps du message n'est pas au format JSON valideVérifie le corps de la requête
401Clé API manquante ou incorrecteVérifie l'en-tête « Authorization »
404La source de données n'a pas été trouvée pour cette cléVérifie le point de terminaison et assure-toi que la clé appartient bien au même compte
413Trop d'enregistrements ou trop volumineuxDivise la requête en petits lots
422Aucun enregistrement n'a pu être enregistréLe message indique quels enregistrements ne comportent pas le champ d'identifiant ou sont trop volumineux
503Sendtric est occupéAttends le nombre de secondes indiqué dans l'en-tête « Retry-After », puis renvoie la même requête

Quand seuls certains enregistrements d'une requête ne sont pas valides, les enregistrements valides sont quand même enregistrés et les autres sont ignorés.

Vérifie tes dossiers

Ouvre la source de données et va dans la section onglet « Enregistrements » ». Effectue une recherche par valeur d'identifiant et clique sur un enregistrement pour voir l'intégralité du JSON Sendtric stocké.

Prochaine étape

Cet article t'a-t-il été utile ?

Clique sur l'image pour zoomer. Fais glisser ou défile pour te déplacer.