2. Cliente: actualización y creación

Cómo crear, actualizar y eliminar un cliente mediante nuestra API

Nuestra API ofrece un punto final especializado para gestionar la creación y modificación de datos de clientes y fidelización. Este punto final admite una serie de actualizaciones en la misma llamada a la API.

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

Punto final

Para gestionar los clientes, dispone del mismo endpoint para añadir varios clientes a la vez y para eliminarlos uno a uno.

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

Debe sustituir el {programId} para su id de programa real que puede encontrar en jericommerce settings > Technical.
Este punto final está protegido por una cabecera de autorización. Consulte nuestra documentación.


Crear y actualizar

Para crear o añadir clientes, usamos una petición POST que acepta un array de objetos.
Esto permite enviar hasta 100 clientes con una sola llamada a la API.

Si uno de los clientes funciona bien, devuelve un 201. Si todos fallan, devuelve un 404. Si todos fallan, devuelve un 404.

Las claves principales de cada objeto son el email del cliente y el nombre de la función, que siempre es "users" y el payload que incluye la información a añadir o actualizar para un cliente.

Esta es la estructura del JSON:

1[
2  {
3    "email": "string",
4    "feature": "users",
5    "payload": {
6      "externalCustomerId": "string",
7      "name": "string",
8      "phone": "string",
9      "emailVerified": boolean,
10      "email": "string"
11    }
12  }
13]


Vamos a explicar los campos de la carga útil uno por uno.

correo electrónico

Este campo se rellena normalmente cuando es necesario actualizar el correo electrónico del cliente.
Si cambia el correo electrónico, la siguiente solicitud de API debe utilizar este nuevo correo electrónico como identificador.
La propiedad de correo electrónico dentro de la carga útil normalmente no está presente para cada actualización.

externalCustomerId

Este es el identificador fuera de Jericommerce, normalmente el identificador de una base de datos externa.
Se requiere para cada actualización o creación.

nombre

Nombre del cliente, mostrado en el pase de Wallet.
Es un valor anulable.

teléfono

Teléfono del cliente
Por defecto, el valor es nulo. Si no envía ningún dato, el campo no se modificará.

emailVerificado

La dirección de correo electrónico del cliente ha sido validada.
Por defecto, el valor es falso. Si desea actualizarlo, puede enviar el valor correcto. Si no se requiere ningún cambio, puede evitar enviarlo.

Borrar cliente

Para eliminar un cliente, utilice el mismo punto final de la API pero con el verbo HTTP DELETE.
Para eliminar clientes debe hacerlo uno por uno, y debe enviar el correo electrónico del cliente que desea eliminar mediante parámetros de consulta.

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

Si todo va bien, recibirá una respuesta 201.

Guías relacionadas
No se han encontrado artículos.

Temas

Integraciones