Invia la API Key dell'amministratore o di un operatore autorizzato e una Secret Key valida per ricevere il `access_token`.
API Pubblica Smartbis v1.9.0
Integra vendite, clienti, dipendenti, benefit e idoneità con il motore di fidelizzazione.
API REST v2 per integrazioni server-to-server con autenticazione Bearer Token, scope espliciti, operazioni idempotenti e controllo dell'accesso di titolari e dipendenti ai piani.
Flusso di base
Dall'autenticazione alla ricompensa automatica.
L'uso principale dell'API è registrare vendite esterne in modo che Smartbis possa elaborare cashback, punti, voucher e comunicazioni secondo le regole del conto.
Usa documento, telefono o ID per individuare e mantenere il cliente sincronizzato.
Invia `sale_amount` per documento, telefono o `customer_id` per attivare il motore fedeltà.
Consulta coupon, voucher, categorie e stock quando l'operazione lo richiede.
Rapida panoramica degli endpoint principali.
Questa sezione funge da porta di accesso prima della documentazione Swagger completa.
POST
/auth/token
Genera il token Bearer per autenticare le chiamate successive.
Auth
GET
/customers
Elenca i clienti o filtra per documento, telefono o ID, con paginazione opzionale.
Customers
POST
/customers
Crea cliente con nome, telefono, password e dati supplementari.
Customers
PATCH
/customers/{customer_id}
Aggiorna i dati anagrafici supportati e permette di attivare o disattivare il cliente tramite il campo `active`.
Customers
GET
/customers/{customer_id}/referrals
Elenca solo i clienti segnalati direttamente dal cliente indicato, rispettando le autorizzazioni di visualizzazione. La richiesta non genera crediti; eventuali ricompense seguono il processo esistente e compaiono nell'estratto conto delle transazioni.
Referrals
GET
/partners
Elenca i partner propri e permette di consultare i dettagli di ciascuna registrazione.
Partners
POST
/partners
Registra un partner rispettando le regole e i limiti del piano.
Partners
PATCH
/partners/{partner_id}
Aggiorna, attiva o disattiva un partner proprio.
Partners
POST
/sales
L'amministratore registra nell'operazione principale. Per registrare in un negozio specifico, usa la API Key di un operatore autorizzato in quel negozio.
Sales
GET
/customers/{customer_id}/transactions
Consulta l'estratto conto paginato, il saldo corrente e, quando applicabile, la composizione del saldo per partner.
Transactions
GET
/coupons
Elenco di coupon/ricompense disponibili per l'operazione.
Coupons
POST
/coupons
Registra una ricompensa utilizzando le regole e i limiti esistenti dell'operazione.
Coupons
PATCH
/coupons/{coupon_id}
Aggiorna, attiva o disattiva una ricompensa esistente.
Coupons
PATCH
/coupons/{coupon_id}/stock
Aggiorna stock di una ricompensa specifica.
Coupons
GET
/vouchers
Elenco voucher con paginazione opzionale.
Vouchers
POST
/vouchers/{voucher_code}/validate
Convalida voucher tramite il codice fornito.
Vouchers
POST
/vouchers/manual-redemptions
Esegue il riscatto manuale esistente, verificando il saldo e registrando il voucher e la movimentazione in modo atomico.
Vouchers
GET
/plans
Elenca i piani per i partecipanti configurati nel club.
Plans
GET
/subscriptions
Elenca le sottoscrizioni e consente di filtrare accessi attivi, morosi, scaduti o annullati.
Subscriptions
GET
/customers/{customer_id}/dependents
Interroga i dipendenti collegati al titolare e la loro idoneità ereditata.
Dependents
POST
/customers/{customer_id}/dependents
Registra un dipendente rispettando azienda, titolare e limite del piano.
Dependents
PATCH
/dependents/{dependent_id}
Aggiorna i dati supportati del dipendente; la sua idoneità rimane ereditata dal titolare.
Dependents
PATCH
/categories/{category_id}
Aggiorna, attiva o disattiva una categoria senza rimuovere i suoi vincoli esistenti.
Categories
GET
/eligibility/reconciliation
Riconcilia le vite attive per piano e periodo, con paginazione.
Eligibility
POST
/webhooks
Registra destinazioni HTTPS per eventi firmati di cambio di idoneità.
Webhooks
POST
/access-links
Emette accesso firmato, breve e monouso per i fornitori collegati.
Access
PATCH
/subscriptions/{customer_id}
Attiva, sospende o termina l'accesso del partecipante a un piano senza modificare gli addebiti nel gateway.
Subscriptions
Oggetti principali
Risorse dell'API organizzate per uso dell'operazione.
La pagina presenta i domini dell'API in linguaggio di prodotto, mentre la documentazione Swagger mantiene i dettagli di schema, parametri e risposte.
Registrazione, ricerca, aggiornamento, attivazione e disattivazione per documento, telefono o ID, rispettando la visibilità dell'operatore.
Registrazione di acquisti esterni per generare cashback, punti o voucher.
Registrazione, aggiornamento, attivazione, disattivazione e controllo dell'inventario delle ricompense.
Consultazione, convalida e riscatto manuale tramite il processo ufficiale, con verifica del saldo.
Creazione, aggiornamento, attivazione e disattivazione delle categorie dell'operazione.
Mantiene partner propri e consulta segnalazioni dirette senza creare una rete multilivello o modificare le ricompense.
Interroga i piani e sincronizza lo stato di accesso dei partecipanti con sistemi e fornitori esterni.
Mantiene i legami familiari e riconcilia titolari e dipendenti attivi senza trasportare dati clinici.
Fornisce eventi firmati con ritentativi e genera token temporanei monouso per fornitori esterni.
La API Key identifica chi registra l'operazione. L'amministratore registra le vendite nell'operazione principale; per un negozio specifico, utilizza la API Key di un operatore autorizzato in quel negozio.
Hai bisogno di collegare un sistema proprier?
Usa la documentazione interattiva per testare gli endpoint, convalidare i payload e implementare il flusso adeguato per la tua integrazione.