Présentation de l’API JeriCommerce

L’API publique de JeriCommerce permet à vos propres systèmes de travailler avec votre programme de fidélité. Elle est disponible pour tous les programmes : il vous suffit d’une clé API.

L’API couvre deux types de tâches :

• Les actions de fidélité : donner des points, attribuer des coupons, échanger des récompenses, envoyer des notifications Wallet et lire les données d’un client. Chaque action est documentée dans Automatisations, avec un onglet API à côté des options Shopify Flow et Klaviyo, pour comparer les canaux et construire votre requête.
• Les endpoints de référence : ceux listés sur cette page, comme le catalogue de récompenses ou l’aperçu du solde.

Si votre propre système doit être la source de vérité pour les clients et les soldes, et recevoir chaque événement client, configurez plutôt l’intégration Custom API. Elle doit être activée dans JeriCommerce et fonctionne en complément de cette API.

URL de base ¶

Tous les endpoints se trouvent sous votre programme :

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

Remplacez {program_slug} par le slug ou l’identifiant de votre programme. Les deux fonctionnent. Vous les trouverez dans JeriCommerce sous Settings > Technical > Program Information.

Authentification ¶

Envoyez votre clé API dans l’en-tête api-key à chaque requête. Une clé appartient à un seul programme et ne fonctionne qu’avec lui. Consultez Authentification via l’API pour en créer une.

Conventions des requêtes ¶

• Les corps de requête et de réponse sont au format JSON. Envoyez Content-Type: application/json.
• Les clients sont identifiés par leur adresse e-mail. Les adresses e-mail ne sont pas sensibles à la casse.
• La plupart des endpoints d’écriture acceptent un tableau d’éléments, ce qui permet d’agir sur plusieurs clients en un seul appel. La limite est de 100 éléments par requête, ou 250 lorsque vous synchronisez des clients ou des informations de fidélité avec l’intégration Custom API.

Endpoints en file d’attente ¶

Increase balance, Decrease balance, Redeem a reward, Assign a coupon et Send a push notification placent chaque élément dans une file d’attente et répondent 201 immédiatement. Un 201 signifie que la requête était valide, pas que chaque élément a réussi. Si un élément échoue ensuite (par exemple, parce que le client n’existe pas ou n’a pas assez de points), l’API ne vous le dit pas. Pour confirmer le résultat, écoutez le webhook d’événements ou lisez le client avec Obtenir les détails d’un client.

Les autres endpoints s’exécutent immédiatement et renvoient le résultat ou une erreur dans la réponse.

Erreurs ¶

Les erreurs renvoient un code de statut HTTP et un corps JSON. Le champ message contient un code que vous pouvez utiliser dans votre intégration :

{
  "statusCode": 404,
  "message": "CUSTOMER_NOT_FOUND",
  "path": "/v1/programs/your-program/customers/someone@example.com",
  "timestamp": "2026-10-11T09:00:00.000Z"
}

Lorsque le corps de la requête est invalide, le statut est 400 et message est la liste des champs qui n’ont pas passé la validation.

Endpoints ¶

L’intégration Custom API ajoute des endpoints pour synchroniser les clients et les informations de fidélité, ainsi que le webhook d’événements.