Nuestra API ofrece un endpoint específico para gestionar la creación y modificación de datos de clientes y de fidelización. Este endpoint permite realizar varios tipos de actualización en una misma llamada a la API.

Utiliza el correo electrónico como identificador principal del cliente y un valor enum para indicar qué parte de la información debe actualizarse.

Endpoint

Para gestionar clientes, puedes usar el mismo endpoint para añadir varios a la vez y eliminarlos de uno en uno.

// POST Endpoint

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

Sustituye {program_slug} por el slug real de tu programa. Puedes encontrarlo en JeriCommerce, en Settings > Technical > Program Information.

Este endpoint está protegido mediante el encabezado api-key. Consulta la documentación de autenticación.

Crear y actualizar

Para crear o añadir clientes, envía una solicitud POST que acepte una matriz de objetos. Puedes enviar hasta 100 clientes en una sola llamada a la API.

Si la operación se completa correctamente para alguno de los clientes, devuelve 201. Si falla para todos, devuelve 404.

Las claves principales de cada objeto son el correo electrónico del cliente, el nombre de la función, que siempre es "users", y el payload con la información que se va a añadir o actualizar.

Esta es la estructura JSON:

[
 {
 "email": "string",
 "feature": "users",
 "payload": {
 "externalCustomerId": "string",
 "firstName": "string",
 "lastName": "string",
 "phone": "string",
 "emailVerified": boolean,
 "email": "string"
 }
 }
]

A continuación se explica cada campo del payload.

email

Este campo suele incluirse cuando es necesario actualizar el correo electrónico del cliente. Si cambias el correo, la siguiente solicitud a la API debe usar el nuevo correo como identificador. Normalmente, la propiedad email no se incluye en el payload de cada actualización.

externalCustomerId

Es el identificador del cliente fuera de JeriCommerce, normalmente el que utiliza una base de datos externa. Es obligatorio en cada creación o actualización.

firstName

El nombre del cliente se muestra como parte de su nombre en la tarjeta de fidelización. Este campo puede ser nulo.

lastName

Los apellidos del cliente se muestran como parte de su nombre en la tarjeta de fidelización. Este campo puede ser nulo.

phone

Teléfono del cliente. De forma predeterminada, el valor es null. Si no envías ningún dato, el campo no cambiará.

emailVerified

Indica si se ha validado la dirección de correo electrónico del cliente. De forma predeterminada, el valor es false. Para actualizarlo, puedes enviar el valor correcto. Si no necesitas cambiarlo, puedes omitirlo.

Eliminar un cliente

Para eliminar un cliente, usa el mismo endpoint con el verbo HTTP DELETE. Debes eliminar los clientes de uno en uno y enviar el correo del cliente que quieres eliminar mediante los parámetros de consulta.

// DELETE Endpoint

https://api.jericommerce.com/v1/programs/{program_slug}/integrations/api?email={customerEmail}

Si la operación se completa correctamente, recibirás una respuesta 201.