La Custom API Integration collega JeriCommerce a un sistema creato o gestito dal tuo team, come un CRM o un programma fedeltà già esistente. Funziona in entrambe le direzioni:
- Il tuo sistema invia dati a JeriCommerce: i clienti e il loro saldo e livello fedeltà, così la loro carta fedeltà mostra sempre i tuoi dati.
- JeriCommerce invia eventi al tuo sistema: ogni evento dei clienti, come una carta installata o un premio riscattato, come webhook al tuo server.
Ti serve questa integrazione solo quando il tuo sistema è la fonte di verità, o quando vuoi ricevere gli eventi. Per agire su un programma fedeltà JeriCommerce dal tuo codice, come assegnare punti o un coupon, non ti serve: usa le azioni in Automazioni con una chiave API.
Attivala ¶
Apri l'integrazione
In JeriCommerce vai su Settings > Integrations > API.
Aggiungi i dati del webhook
In Webhook URL (where you receive our updates) inserisci l'URL del tuo server che riceverà gli eventi. In Secret inserisci il valore che JeriCommerce userà per firmarli, così il tuo server può verificare che siano autentici.
Scegli le funzionalità
Attiva le funzionalità che ti servono, poi fai clic su Save.
| Funzionalità | Attivala quando | Guida |
|---|---|---|
| Customer | Il tuo sistema crea e aggiorna i clienti in JeriCommerce. | Sincronizza i clienti |
| Loyalty | Il tuo programma fedeltà gira in un altro sistema e JeriCommerce deve mostrare saldo e livello che invii. | Sincronizza le informazioni fedeltà |
| Events | Il tuo server deve ricevere ogni evento dei clienti. | Webhook degli eventi |
Disattivare Loyalty elimina le informazioni fedeltà (saldo, stato del livello e data di iscrizione) di ogni cliente del programma. Disattivala solo se passi a un altro programma fedeltà e, se la riattivi, invia di nuovo i saldi.
Autenticazione ¶
Gli endpoint di sincronizzazione usano la stessa chiave API del resto dell'API, nell'header api-key. Consulta Autenticazione tramite API. Se l'integrazione o la funzionalità non è attiva, rispondono 403 con API_INTEGRATION_REQUIRED, API_USERS_REQUIRED o API_LOYALTY_REQUIRED.
Gli eventi inviati al tuo server sono firmati con il tuo Secret nell'header x-jericommerce-hmac-sha256. Consulta il webhook degli eventi per sapere come verificarli.