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 el campo feature para indicar qué parte de la información debe actualizarse.
Antes de empezar ¶
Este endpoint forma parte de la integración API personalizada. Solo funciona cuando la integración está activa en JeriCommerce, en Settings > Integrations > API, y la función Customer está activada. Si no, responde 403 con API_INTEGRATION_REQUIRED o API_USERS_REQUIRED.
Este endpoint está protegido mediante el encabezado api-key. Consulta la documentación de autenticación.
Crear y actualizar ¶
POST 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.
El cuerpo de la solicitud es una matriz de objetos, así que puedes enviar hasta 250 clientes en una sola llamada a la API.
Cada objeto incluye el correo electrónico del cliente, el nombre de la función, que para los datos de cliente es siempre users, y el payload con la información que se va a añadir o actualizar. Si todavía no existe ningún cliente con ese correo, JeriCommerce lo crea.
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 ¶
Envía este campo solo cuando el correo del cliente deba cambiar. Usa el correo actual como email del objeto y el correo nuevo dentro del payload.
Después del cambio, la siguiente solicitud a la API debe usar el nuevo correo como identificador.
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.
Response ¶
Los elementos se procesan en orden, mientras la solicitud sigue abierta. Una respuesta 201 con el cuerpo vacío significa que se han guardado todos los elementos.
Si un elemento falla, la solicitud se detiene ahí y devuelve el error. Los elementos anteriores ya están guardados y los posteriores no se procesan, así que corrige el elemento que falla y vuelve a enviar los que faltan.
Eliminar un cliente ¶
Para eliminar un cliente, usa el mismo endpoint con el verbo HTTP DELETE y el correo del cliente en el parámetro de consulta email. Los clientes se eliminan de uno en uno.
DELETE https://api.jericommerce.com/v1/programs/{program_slug}/integrations/api?email={customerEmail}
Esto elimina al cliente completo de JeriCommerce, incluida su información de fidelización, y no se puede deshacer. Si todo va bien, recibirás una respuesta 200. Si ningún cliente tiene ese correo, recibirás un 404 con CUSTOMER_NOT_FOUND.
Errores ¶
| Código | Estado | Significado |
|---|---|---|
API_INTEGRATION_REQUIRED |
403 |
La integración API no está activa en este programa. |
API_USERS_REQUIRED |
403 |
La función Customer está desactivada en la integración API. |
FEATURE_NOT_ENABLED |
400 |
El valor de feature no es users ni loyalty. |
MAX_OBJECTS_PER_REQUEST_EXCEEDED |
400 |
La matriz tiene más de 250 elementos. |
CUSTOMER_NOT_FOUND |
404 |
Solo en DELETE. Ningún cliente tiene ese correo. |