Para desarrolladores

La API de loyal para cajas, tiendas online y sistemas propios

Una API REST con clave de API: tu caja abona sellos y puntos, tu tienda online notifica los pedidos y tu sistema registra clientes y canjea tarjetas. Todos los endpoints están descritos en la documentación.

Abrir la documentación de la APIClaves de API en el portal

Documentación en inglés, de acceso libre sin iniciar sesión

Ejemplo de la documentación: puntos por facturación en caja (loyal COMMERCE)
POST /transaction/revenue
Host: api.loyal-app.de
X-API-Key: your-api-key-here
Content-Type: application/json

{ "userId": "1234567890123",
  "totalCents": 2490 }

→ 24 puntos con 1 punto por euro

Lo que conectas a través de la API

loyal COMMERCE: puntos de la tienda online y del local

Tu tienda online notifica los pedidos pagados; cada número de pedido se abona una sola vez y las anulaciones descuentan los puntos. Los puntos se convierten en códigos de vale que tu tienda comprueba e invalida. Con loyal COMMERCE en modo facturación, tu caja abona la facturación del local en la misma cuenta de puntos.

  • POST /shop/orders
  • POST /shop/orders/{orderId}/cancel
  • POST /shop/redeem
  • POST /transaction/revenue
Sección loyal COMMERCE en la documentación

Conexión con la caja: abonar y canjear sellos

Tu caja abona sellos, consulta el saldo de una tarjeta y canjea las tarjetas completas. Registras a los clientes nuevos con su correo electrónico; la respuesta contiene el ID de cliente para todas las llamadas siguientes.

  • POST /user
  • POST /transaction
  • GET /user
  • POST /redeem
Primeros pasos con la caja en la documentación

Gestiona tú mismo las claves de API

Creas las claves tú mismo en el portal, con el rol POS (caja) o ADMIN. La clave completa solo se muestra una vez; después, enmascarada. Para cambiarla, creas una nueva y desactivas la anterior. Cada petición la envía en la cabecera X-API-Key.

  • X-API-Key
Autenticación en la documentación

Conecta tu caja en cuatro pasos

  1. Crea en el portal una clave de API con el rol POS.
  2. Registra clientes: POST /user con el correo electrónico.
  3. Abona sellos: POST /transaction.
  4. Canjea las tarjetas completas: POST /redeem.
Abrir la documentación de la APIClaves de API en el portal