La nostra API include un endpoint specifico per gestire la creazione e la modifica dei dati cliente e fedeltà. Permette di effettuare diverse modifiche nella stessa chiamata API.

Usa l'email come identificativo principale del cliente e un enum per specificare quale parte delle sue informazioni aggiornare.

Endpoint

Puoi usare lo stesso endpoint per aggiungere più clienti contemporaneamente o eliminarli uno per uno.

// POST Endpoint

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

Sostituisci {program_slug} con lo slug effettivo del programma. Puoi trovarlo in JeriCommerce in Settings > Technical > Program Information.

L'endpoint è protetto dall'header api-key. Consulta la documentazione sull'autenticazione.

Crea e aggiorna

Per creare o aggiungere clienti, invia una richiesta POST con un array di oggetti. Puoi inviare fino a 100 clienti in una chiamata API.

Se almeno un cliente viene elaborato correttamente, la risposta è 201. Se tutte le operazioni falliscono, la risposta è 404.

Le chiavi principali di ogni oggetto sono l'email del cliente, il nome della funzionalità, che è sempre users, e il payload con i dati da aggiungere o aggiornare.

Ecco la struttura JSON:

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

Vediamo una per una le proprietà del payload.

email

In genere questo campo viene valorizzato quando occorre aggiornare l'email del cliente. Se la modifichi, la richiesta API successiva deve usare la nuova email come identificativo. Di norma, la proprietà email non viene inclusa nel payload di ogni aggiornamento.

externalCustomerId

È l'identificativo del cliente esterno a JeriCommerce, di solito quello del database esterno. È obbligatorio per ogni creazione o aggiornamento.

firstName

Il nome del cliente viene mostrato sulla carta fedeltà. Può avere valore nullo.

lastName

Il cognome del cliente viene mostrato sulla carta fedeltà. Può avere valore nullo.

phone

Numero di telefono del cliente. Per impostazione predefinita il valore è null. Se non invii un dato, il campo non viene modificato.

emailVerified

Indica se l'indirizzo email del cliente è stato convalidato. Per impostazione predefinita il valore è false. Per aggiornarlo, invia il valore corretto. Se non occorre modificarlo, puoi ometterlo.

Elimina un cliente

Per eliminare un cliente, usa lo stesso endpoint API con il verbo HTTP DELETE. I clienti vanno eliminati uno alla volta: invia l'email del cliente da eliminare come parametro di ricerca.

// DELETE Endpoint

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

Se l'operazione riesce, riceverai una risposta 201.