L’intégration Custom API relie JeriCommerce à un système que votre équipe a créé ou qu’elle gère, comme un CRM ou un programme de fidélité existant. Elle fonctionne dans les deux sens :
- Votre système envoie des données à JeriCommerce : les clients, ainsi que leur solde de fidélité et leur niveau, pour que leur carte de fidélité affiche toujours vos données.
- JeriCommerce envoie des événements à votre système : chaque événement client, comme une carte installée ou une récompense échangée, sous forme de webhook vers votre serveur.
Vous n’avez besoin de cette intégration que si votre propre système est la source de vérité, ou si vous voulez recevoir les événements. Pour agir sur un programme de fidélité JeriCommerce depuis votre code, comme donner des points ou attribuer un coupon, vous n’en avez pas besoin : utilisez les actions présentées dans Automatisations avec une clé API.
L’activer ¶
Ouvrir l’intégration
Dans JeriCommerce, allez dans Settings > Integrations > API.
Ajouter les informations du webhook
Dans Webhook URL (where you receive our updates), saisissez l’URL de votre serveur qui recevra les événements. Dans Secret, saisissez la valeur que JeriCommerce utilisera pour les signer, afin que votre serveur puisse vérifier qu’ils sont authentiques.
Choisir les fonctionnalités
Activez les fonctionnalités dont vous avez besoin, puis cliquez sur Save.
| Fonctionnalité | À activer quand | Guide |
|---|---|---|
| Customer | Votre système crée et met à jour des clients dans JeriCommerce. | Synchroniser les clients |
| Loyalty | Votre programme de fidélité fonctionne dans un autre système, et JeriCommerce doit afficher le solde et le niveau que vous envoyez. | Synchroniser les informations de fidélité |
| Events | Votre serveur doit recevoir chaque événement client. | Webhook d’événements |
Désactiver Loyalty supprime les informations de fidélité (solde, statut de niveau et date d’adhésion) de tous les clients du programme. Ne le désactivez que si vous passez à un autre programme de fidélité, et renvoyez les soldes si vous le réactivez.
Authentification ¶
Les endpoints de synchronisation utilisent la même clé API que le reste de l’API, dans l’en-tête api-key. Consultez Authentification via l’API. Si l’intégration ou la fonctionnalité n’est pas activée, ils répondent 403 avec API_INTEGRATION_REQUIRED, API_USERS_REQUIRED ou API_LOYALTY_REQUIRED.
Les événements envoyés à votre serveur sont signés avec votre Secret dans l’en-tête x-jericommerce-hmac-sha256. Consultez le webhook d’événements pour savoir comment le vérifier.