☰ Menú · Introducción
Primeros pasos

API de Loyaltyfy

Conecta una caja, un sistema de reservas, un quiosco o tu propia app con las tarjetas de fidelización, las cartas QR y los pedidos en mesa de Loyaltyfy.

Loyaltyfy gestiona programas de fidelización y cartas digitales para restaurantes, cafeterías, tiendas y salones. Los clientes guardan su tarjeta en Apple Wallet o Google Wallet, y el local ve cada visita y cada ticket. La API permite que los sistemas que el local ya usa participen: la caja suma cashback al cerrar un ticket, un quiosco en la entrada sella una visita, un sistema de reservas premia una cita a la que el cliente asistió, el TPV recoge los pedidos que los clientes envían desde la carta QR.

Es una API REST sencilla sobre HTTPS. Las peticiones y respuestas son JSON, los importes son enteros en unidades mínimas (12500 es 125,00) y las fechas siguen ISO 8601. Cada local tiene sus propias claves, así que una misma integración sirve para cualquier número de locales: guardas una clave por local y la envías en cada llamada.

Elige por dónde empezar

URL base

Todos los endpoints están bajo https://loyaltyfy.io/api/v1. Las rutas de esta documentación empiezan en /v1, así que GET /v1/members significa GET https://loyaltyfy.io/api/v1/members.

Objetos principales

ObjetoQué es
memberUn cliente inscrito en el programa de fidelización del local, con una tarjeta en el wallet. Se busca por número de tarjeta, código de barras, teléfono o id.
transactionUn ticket cerrado que envía una caja. Genera cashback o sellos, puede canjear cashback y se puede anular.
visitUn registro de visita sin ticket, desde un quiosco, un escáner o un sistema de reservas.
menu, menu_itemLa carta QR del local: categorías, platos, modificadores, precios y productos agotados.
orderUn carrito que un cliente envía desde la carta QR en la mesa. El TPV lo acepta y lo hace avanzar por los estados.
eventAlgo que ha ocurrido (se aplicó un ticket, entró un pedido) y que se entrega en tu endpoint de webhook.

Siguiente paso

Haz tu primera llamada con el Inicio rápido. Con una clave de prueba tardas unos cinco minutos.

Dudas sobre una integración: api@loyaltyfy.io. Respondemos en un día hábil.