La integración API personalizada conecta JeriCommerce con un sistema que tu equipo ha creado o gestiona, como un CRM o un programa de fidelización que ya tengas. Funciona en las dos direcciones:
- Tu sistema envía datos a JeriCommerce: los clientes y su saldo y nivel de fidelización, para que su tarjeta de fidelización muestre siempre tus datos.
- JeriCommerce envía eventos a tu sistema: todos los eventos de los clientes, como una tarjeta instalada o una recompensa canjeada, como webhook a tu servidor.
Solo necesitas esta integración cuando tu propio sistema es la fuente de verdad, o cuando quieres recibir eventos. Para actuar sobre un programa de fidelización de JeriCommerce desde tu código, como dar puntos o asignar un cupón, no la necesitas: usa las acciones de Automatizaciones con una clave de API.
Actívala ¶
Abre la integración
En JeriCommerce, ve a Settings > Integrations > API.
Añade los datos de tu webhook
En Webhook URL (where you receive our updates), introduce la URL de tu servidor que recibirá los eventos. En Secret, introduce el valor que JeriCommerce usará para firmarlos, de modo que tu servidor pueda comprobar que son auténticos.
Elige las funciones
Activa las funciones que necesites y haz clic en Save.
| Función | Actívala cuando | Guía |
|---|---|---|
| Customer | Tu sistema crea y actualiza clientes en JeriCommerce. | Sincronizar clientes |
| Loyalty | Tu programa de fidelización funciona en otro sistema y JeriCommerce debe mostrar el saldo y el nivel que le envías. | Sincronizar información de fidelización |
| Events | Tu servidor debe recibir todos los eventos de los clientes. | Webhook de eventos |
Al desactivar Loyalty se elimina la información de fidelización (saldo, estado de nivel y fecha de alta) de todos los clientes del programa. Desactívala solo si te pasas a otro programa de fidelización, y vuelve a enviar los saldos si la activas de nuevo.
Autenticación ¶
Los endpoints de sincronización usan la misma clave de API que el resto de la API, en el encabezado api-key. Consulta Autenticación mediante la API. Si la integración o la función no está activada, responden 403 con API_INTEGRATION_REQUIRED, API_USERS_REQUIRED o API_LOYALTY_REQUIRED.
Los eventos enviados a tu servidor se firman con tu Secret en el encabezado x-jericommerce-hmac-sha256. Consulta el webhook de eventos para ver cómo comprobarlo.