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. Le champ feature indique quelle partie des informations du client doit être mise à jour.

Avant de commencer

Ce point de terminaison fait partie de l’intégration Custom API. Il ne fonctionne que si l’intégration est active dans JeriCommerce sous Settings > Integrations > API, avec la fonctionnalité Customer activée. Sinon, il répond 403 avec API_INTEGRATION_REQUIRED ou API_USERS_REQUIRED.

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

POST 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.

Le corps de la requête est un tableau d’objets : vous pouvez donc envoyer jusqu’à 250 clients en un seul appel API.

Chaque objet contient l’adresse e-mail du client, le nom de la fonctionnalité, toujours users pour les données client, et le payload avec les informations à ajouter ou à modifier. Si aucun client n’a cette adresse e-mail, JeriCommerce en crée un.

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

N’envoyez ce champ que si l’adresse e-mail du client doit changer. Utilisez l’adresse actuelle comme email de l’objet et la nouvelle adresse dans le payload. Après le changement, la prochaine requête API doit utiliser cette nouvelle adresse comme identifiant.

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.

Réponse

Les éléments sont traités dans l’ordre, pendant que la requête est ouverte. Une réponse 201 avec un corps vide signifie que tous les éléments ont été enregistrés.

Si un élément échoue, la requête s’arrête à cet endroit et renvoie l’erreur. Les éléments précédents sont déjà enregistrés et les suivants ne sont pas traités : corrigez l’élément en erreur et renvoyez les éléments restants.

Supprimer un client

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

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

Cette action supprime entièrement le client de JeriCommerce, y compris ses informations de fidélité, et elle est irréversible. Si tout se passe bien, vous recevez une réponse 200. Si aucun client n’a cette adresse e-mail, vous recevez une réponse 404 avec CUSTOMER_NOT_FOUND.

Erreurs

Code Statut Signification
API_INTEGRATION_REQUIRED 403 L’intégration API n’est pas active pour ce programme.
API_USERS_REQUIRED 403 La fonctionnalité Customer est désactivée dans l’intégration API.
FEATURE_NOT_ENABLED 400 La valeur de feature n’est ni users ni loyalty.
MAX_OBJECTS_PER_REQUEST_EXCEEDED 400 Le tableau contient plus de 250 éléments.
CUSTOMER_NOT_FOUND 404 DELETE uniquement. Aucun client n’a cette adresse e-mail.