Checkit

Checkit è una piattaforma cloud per la gestione automatica della fidelizzazione clienti.

Base URI

http://www.checkit-mobile.it/api/v1
Introduzione

Se necessiti di assistenza o hai bisogno di maggiori chiarimenti sull'uso delle API scrivi all'indirizzo email: assistenza@checkit-mobile.it

Con le API REST potrai collegare l'applicazione mobile Checkit al tuo software (Gestionale, POS, etc.) ottenendo una piattaforma completa di gestione clienti.

Potrai focalizzarti nello sviluppo delle funzioni principali che rendono il tuo software importante per i tuoi clienti e con pochi semplici passaggi collegare l'applicazione Checkit al tuo sistema per permettere all'attività commerciale di gestire anche il programma fedeltà in modo completamente automatico e senza nessuno sforzo da parte tua.

Checkit gestisce il catalogo premi dell'attività commerciale ed il portafoglio punti degli utenti che può essere consultato in tempo reale direttamente dall'applicazione mobile.

Con le nostre API puoi accreditare ai clienti un numero di punti fissato oppure un numero di punti in funzione della cifra spesa e mantenere sincronizzata l'anagrafica clienti di Checkit con il tuo software.

Cosa serve per iniziare

L'attività commerciale deve possedere un account business sulla piattaforma Checkit. Ad ogni attività commerciale viene assegnata una chiave di autenticazione che servirà al tuo software per comunicare con il suo account su Checkit.

Per maggiori informazioni su come attivare un account business su Checkit vai su: http://video.clientiaffezionati.it/apply

Autorizzazione delle richieste

Ogni richiesta verso le API deve essere autorizzata attraverso lì'invio di una chiave di autenticazione.

Nell'area privata dedicata agli account business Checkit, nella sezione "Impostazioni", puoi trovare la chiave di autenticazione dell'attività commerciale.

Qusta chiave è una stringa alfa-numerica che deve essere obbligatoriamente allegata ad ogni richiesta eseguita verso le API inserendola nel campo Authorization dell'header HTTP.

Authorization
string required

La chiave di autenticazione della propria attività commerciale su Checkit.

Example:
Authorization: hsd87tsd7wh9weh829w0wj9
Anagrafica clienti

Sincronizzazione e gestione dell'anagrafica clienti.

GET /customers
GET /customers/{id}
Elenco clienti
GET /customers

Ottieni la lista dei clienti che hanno un portafoglio punti nell'attività commerciale.

Request headers

Authorization
string required

Chiave di autenticazione account business Checkit.

Profilo cliente
GET /customers/{id}

Ottieni il profilo dettagliato del cliente.

Path variables

id
integer required

ID del cliente.

Request headers

Authorization
string required

Chiave di autenticazione account business Checkit.

Gestione portafogli

Gestione del portafoglio punti del cliente.

GET /wallets
GET /wallets?email=example@email.com
POST /wallets
Elenco portafogli
GET /wallets

Elenco di tutti i portafogli attivi.

Request headers

Authorization
string required

Chiave di autenticazione account business Checkit.

Portafoglio punti del cliente
GET /wallets?email=example@email.com

Ottieni il dettalgio di un portafoglio punti di un cliente.

Request parameters

email
string required

Indirizzo email dell'account Checkit del cliente

Request headers

Authorization
string required

Chiave di autenticazione dell'account business Checkit.

Accredito punti
POST /wallets

Se il cliente ha già un portafoglio punti presso l'attività commerciale vengono sommati i punti indicati al saldo corrente.

Se il cliente non ha già un portafoglio punti attivo ne verrà creato uno con la quantità di punti indicata inviando una notifica push sullo smartphone per segnalargli la nuova raccolta punti attiva.

E' necessario che la persona abbia già un account sull'app mobile Checkit dalla quale potrà ricevere le notifiche push e controllare in tempo reale il proprio saldo.

Request parameters

email
string required

Indirizzo email dell'account Checkit del cliente

amount
number optional

Soldi spesi dal cliente dal quale checkit calcolerà automaticamente i punti da assegnare.

coins
string optional

Se non è indicata la cifra spesa del cliente, puoi inviare diretamente dal tuo software il numero di punti da accreditare.

Default:
10

Request headers

Authorization
string required

Chiave di autenticazione account business Checkit.