Esta lista te guía por todo lo que necesitas antes de activar JeriCommerce mediante la integración de API. Está pensada para equipos que administran los clientes y sus datos de fidelización en su propia plataforma y quieren sincronizarlos con JeriCommerce para ofrecer Wallet Passes, notificaciones push y campañas.
Elige esta opción si tu proveedor o plataforma de fidelización sigue siendo la fuente de los datos de clientes y puntos. La opción de Shopify para incorporar un programa existente es específica de LoyaltyLion. Si usas otro proveedor, sigue esta lista de API en vez de crear un segundo programa de puntos en JeriCommerce.
1. Revisar las herramientas ¶
Antes de empezar, confirma qué herramientas usarás:
- Tu plataforma: el sistema donde se guardan los datos de clientes y fidelización, como un CRM, backend personalizado o ERP.
- JeriCommerce Wallet, instalada desde Shopify App Store o configurada de forma independiente.
- Un desarrollador o equipo técnico capaz de enviar solicitudes HTTP a la API de JeriCommerce.
La integración de API está diseñada para equipos que ya tienen un sistema de fidelización o una base de datos de clientes y quieren conectarlos con las funciones de cartera y notificaciones de JeriCommerce.
2. Crear las credenciales de API ¶
Crear una API key ¶
- En el panel de JeriCommerce, ve a Settings > Technical > API Keys.
- Haz clic en Create API Key, asígnale un nombre y copia el valor. Solo podrás verlo una vez.
Cómo funciona la autenticación de API
Encontrar el slug del programa ¶
- Ve a Settings > Technical > Program Information.
- Copia el Program Slug. Lo usarás en las URL de todos los endpoints de API.
Todas las solicitudes de API se envían a:
https://api.jericommerce.com/v1/programs/{program_slug}/integrations/api
3. Sincronizar los clientes ¶
Envía los datos de tus clientes a JeriCommerce para generar un Wallet Pass para cada uno.
- Usa el endpoint
POSTconfeature: "users"para crear o actualizar clientes. - Puedes enviar hasta 250 clientes por solicitud.
- Campo obligatorio:
email. Campos opcionales:firstName,lastName,phone,externalCustomerIdyemailVerified.
Referencia de la API de clientes
Si también administras los datos de fidelización, puedes enviar los payloads de clientes y fidelización en una misma solicitud. Asegúrate de que el cliente aparezca antes que los datos de fidelización.
4. Sincronizar los datos de fidelización ¶
Si tu plataforma registra los puntos, niveles o el estado de la membresía, sincroniza esos datos con JeriCommerce para que aparezcan en el Wallet Pass.
- Usa el endpoint
POSTconfeature: "loyalty"para enviar el saldo, el nivel y la fecha de inscripción. - Campos obligatorios:
loyaltyCustomerId,balanceymemberSince. - Campo opcional:
tierStatus, el nombre del nivel que aparece en el Wallet Pass.
Referencia de la API de fidelización
El cliente debe existir en JeriCommerce antes de añadir sus datos de fidelización. Si sincronizas ambos en una sola solicitud, coloca el payload del cliente antes del payload de fidelización.
5. Configurar webhooks (suscripciones a eventos) ¶
Suscríbete a los eventos de JeriCommerce para mantener tu plataforma sincronizada con la actividad de Wallet.
- Ve a Settings > Integrations > API e introduce tu Webhook URL.
- JeriCommerce enviará solicitudes HTTP POST a esa URL para los 19 eventos.
- Cada solicitud incluye una firma HMAC-SHA256 en el encabezado
x-jericommerce-hmac-sha256para verificarla.
Entre los eventos disponibles están la instalación o eliminación de Wallet Pass, cambios de saldo o nivel, canjes de recompensas y escaneos de clientes en POS.
Referencia completa de eventos
6. Diseñar y configurar Wallet Pass ¶
Personalizar la tarjeta de fidelización ¶
- Abre Customize → Loyalty card y elige Apple o Google.
- En Card, personaliza las ilustraciones y los colores de tu marca. Abre Details para editar las secciones posteriores del pase.
Añadir enlaces importantes al pase ¶
Configura secciones y enlaces en la parte posterior de Wallet Pass para acceder rápidamente a:
- Tu sitio web o portal de clientes.
- Las páginas de recompensas, cuenta o portal de clientes.
- Páginas de producto o de destino.
7. Enlaces de descarga de Wallet ¶
Genera enlaces de descarga para que los clientes puedan instalar Wallet Pass.
- Usa la API Customer Tokens para generar tokens
downloadde cada cliente. - El formato de la URL de descarga es
https://jeri.link/{slug}/download?token={base64Token}. - También puedes generar tokens
authpara acceder directamente a la aplicación del cliente, como recompensas o perfil.
Opciones de distribución:
- Incluye enlaces de descarga en correos o mensajes SMS.
- Añádelos a páginas de cuenta, perfil o aplicación web.
- Inclúyelos en flujos posteriores a la compra.
8. Configuración específica de tienda y cuenta en Shopify ¶
Si usas Shopify con una integración de API personalizada, suele ser más útil elegir ubicaciones específicas para la tienda y la cuenta que usar un único Hub predeterminado. Usa las opciones que se adapten al recorrido actual de tus clientes:
- Storefront Widget y Web App: añade un acceso flotante o un enlace que abre la aplicación web del cliente, las recompensas y las acciones de Wallet.
- Bloque de fidelización de cuenta: muestra el resumen de fidelización en las cuentas de cliente de Shopify.
- Estado de nivel en la cuenta: muestra los puntos y el nivel en el área de cuenta.
- Account Rewards: permite consultar y canjear recompensas desde la cuenta.
- Extensión de descarga de Wallet Pass: añade el botón de descarga de la tarjeta de fidelización a páginas de cuenta, perfil o tema.
9. Campañas y notificaciones ¶
Cuando los clientes tengan Wallet Passes, puedes interactuar con ellos mediante notificaciones push:
Notificaciones push ¶
- Anuncia rebajas, novedades u ofertas por tiempo limitado.
Cómo funcionan las notificaciones push
Campañas basadas en ubicación ¶
- Activa una notificación push cuando los clientes estén cerca de una tienda.
Cómo funcionan las notificaciones por ubicación
10. Omnicanal: Shopify POS ¶
Si tienes tiendas físicas que usan Shopify POS:
- Añadir mosaicos de JeriCommerce a Shopify POS
- Escanear la tarjeta de fidelización en Shopify POS
- Añadir un código QR a los recibos
- Descarga desde el panel de administración de JeriCommerce un cartel con un Store QR Code para mostrar en la tienda.
Ya está todo listo para lanzar JeriCommerce con la integración de API.