Notre API propose un point de terminaison spécialisé pour gérer la création et la modification des données client et de fidélité. Ce point de terminaison permet d’effectuer plusieurs types de mise à jour au cours d’un même appel API.

L’adresse e-mail sert d’identifiant principal du client. Une valeur d’énumération indique quelle partie des informations du client doit être mise à jour.

Point de terminaison

Pour gérer les clients, vous pouvez utiliser le même point de terminaison pour en ajouter plusieurs à la fois ou les supprimer un par un.

// POST Endpoint

https://api.jericommerce.com/v1/programs/{program_slug}/integrations/api

Remplacez {program_slug} par le slug réel de votre programme. Vous le trouverez dans JeriCommerce sous Settings > Technical > Program Information.

Ce point de terminaison est sécurisé par l’en-tête api-key. Consultez la documentation sur l’authentification.

Créer et mettre à jour

Pour créer ou ajouter des clients, envoyez une requête POST contenant un tableau d’objets. Vous pouvez envoyer jusqu’à 100 clients en un seul appel API.

Si la requête réussit pour au moins un client, la réponse est 201. Si elle échoue pour tous, la réponse est 404.

Les principales clés de chaque objet sont l’adresse e-mail du client, le nom de la fonctionnalité, toujours défini sur "users", et le payload contenant les informations à ajouter ou à modifier pour le client.

Voici la structure JSON :

[
 {
 "email": "string",
 "feature": "users",
 "payload": {
 "externalCustomerId": "string",
 "firstName": "string",
 "lastName": "string",
 "phone": "string",
 "emailVerified": boolean,
 "email": "string"
 }
 }
]

Voici le détail des champs du payload.

email

Ce champ sert généralement à mettre à jour l’adresse e-mail du client. Si vous modifiez l’adresse e-mail, la prochaine requête API doit utiliser cette nouvelle adresse comme identifiant. En principe, la propriété email dans le payload n’est pas présente lors de chaque mise à jour.

externalCustomerId

Il s’agit de l’identifiant du client dans un système externe, généralement celui d’une base de données externe. Ce champ est obligatoire pour chaque création ou mise à jour.

firstName

Le prénom du client apparaît dans son nom sur la carte de fidélité. Cette valeur peut être nulle.

lastName

Le nom du client apparaît dans son nom sur la carte de fidélité. Cette valeur peut être nulle.

phone

Numéro de téléphone du client. Par défaut, sa valeur est nulle. Si vous n’envoyez aucune donnée, le champ ne sera pas modifié.

emailVerified

Indique si l’adresse e-mail du client a été vérifiée. Par défaut, cette valeur est false. Pour la modifier, envoyez la valeur correcte. Si aucune modification n’est nécessaire, vous pouvez omettre ce champ.

Supprimer un client

Pour supprimer un client, utilisez le même point de terminaison API avec la méthode HTTP DELETE. Les clients doivent être supprimés un par un. Indiquez l’adresse e-mail du client à supprimer dans les paramètres de requête.

// DELETE Endpoint

https://api.jericommerce.com/v1/programs/{program_slug}/integrations/api?email={customerEmail}

Si tout se passe bien, vous recevez une réponse 201.