Mi cuenta
Los endpoints del usuario final: sus puntos, sus beneficios, su historial y su nivel en tu programa.
Endpoints del usuario final, autenticados con el token de acceso que devuelve verificar el código:
Authorization: Bearer {access}
X-Commerce-Id: {tu-commerce-id}Todo lo que devuelven está limitado al comercio del header X-Commerce-Id:
puntos, beneficios, historial y nivel son los de ese programa y nada más. Un
mismo usuario puede estar en varios programas de Loybox y cada uno ve sólo el
suyo.
El circuito típico
Así se arma una web de fidelidad con estos endpoints:
El primer render
GET /v1/me trae de una los puntos, la marca
del comercio y los puntos por vencer. Con una sola llamada pintás el header y el
saldo.
El catálogo
GET /v1/me/benefits/available
para mostrar qué puede canjear.
El canje
POST /v1/me/benefits/exchange
cambia puntos por un beneficio.
Los códigos
GET /v1/me/benefits para mostrarle
los códigos que tiene para presentar en el comercio.
Al armar la UI
Tres cosas que ahorran vueltas:
- El
client_benefit_codede cada beneficio del usuario es a la vez el código de cupón: en una tienda online es lo que el usuario pega en el checkout. - Los beneficios traen
benefit_type, que distingue los del catálogo (normal) de las recompensas especiales (welcome,birthday,monthly_top,level), ycolor, el color de marca del comercio. - Cuánto le falta al usuario para un beneficio se calcula con el
costdel beneficio menos lospointsdeGET /v1/me.
Comprar y canjear no son lo mismo
| Comprar | Canjear | |
|---|---|---|
| Qué hace | Cambia puntos por un beneficio | Usa el beneficio en el comercio |
| Quién lo llama | El usuario, desde tu web | Tu servidor, en la venta |
| Endpoint | POST /v1/me/benefits/exchange | POST /v1/benefits/redeem |
| Credencial | Token del usuario | API key del comercio |
Los endpoints
Mi cuenta
Puntos, marca del comercio y puntos por vencer, en una llamada.
Beneficios que puedo comprar
El catálogo vigente del comercio.
Comprar un beneficio
Cambia puntos por un beneficio. Acepta Idempotency-Key.
Mis beneficios
Los que ya compró, con su código de canje.
Mi historial
Consumos, compras, canjes y recompensas. Paginado por cursor.
Mi nivel
Nivel actual, multiplicador y progreso al siguiente.
Recompensas del programa
Bienvenida, cumpleaños y cliente del mes.
Adherirme al programa
Sumarse al club. Devuelve la recompensa de bienvenida.
Darme de baja
Salirse del club sin perder los puntos.
El 401 en toda la sección
Todos estos endpoints devuelven 401 cuando el token de acceso falta, venció o
no corresponde a un usuario final. Es el caso normal cuando pasó el tiempo:
renovalo y reintentá la llamada.