API Pubblica Smartbis

Integra vendite, clienti, coupon e voucher nel motore di fidelizzazione.

API REST v2 per integrazioni server-to-server con autenticazione Bearer Token, comunicazione JSON e endpoint per attivare ricompense in tempo reale.

Apri documentazione Vedi su Postman

Base URL https://api.smartbis.com/v2

# 1. generare token
POST /auth/token
{
  "api_key": "{{api_key}}",
  "api_secret": "{{api_secret}}"
}

# 2. registrare vendita
POST /sales
Authorization: Bearer {"{access_token}"}
{
  "cpf": "12345678901",
  "sale_amount": 100.00,
  "description": "Vendita registrata tramite API"
}

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.

01 Genera token

Invia `api_key` e `api_secret` per ricevere il `access_token`.

02 Crea o trova cliente

Usa CPF, telefono, email o ID per sincronizzare il cliente.

03 Registra vendita

Invia `sale_amount` tramite CPF o `customer_id` per attivare il motore di fidelizzazione.

04 Convalida benefici

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

Elenco clienti o filtra per CPF con paginazione opzionale.

Customers

POST /customers

Crea cliente con nome, telefono, password e dati supplementari.

Customers

POST /sales

Registra vendita tramite CPF o ID del cliente e applica la regola di fidelizzazione.

Sales

GET /coupons

Elenco di coupon/ricompense disponibili per l'operazione.

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

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.

Clienti

Registrazione, ricerca per CPF, telefono, email e dati per la relazione.

Vendite

Registrazione di acquisti esterni per generare cashback, punti o voucher.

Buoni

Elenco e controllo dell'inventario delle ricompense disponibili.

Buoni

Consultazione e convalida dei voucher utilizzati dal cliente.

Categorie

Creazione e elenco delle categorie usate nell'organizzazione dell'operazione.

Autenticazione

Generazione di token Bearer con `api_key` e `api_secret`.

Hai bisogno di collegare un sistema proprier?

Usa la documentazione interattiva per testare gli endpoint, convalidare i payload e allineare il flusso ideale con il team tecnico.

Apri Swagger