La API de LoyaltyPro permite conectar tu sistema con nuestra plataforma de lealtad para que puedas registrar puntos, consultar socios, validar información e integrar programas de recompensas dentro de tu propio software.

Esta API puede integrarse con:

• E-commerce
• Sistemas de Punto de Venta (POS)
• Aplicaciones móviles
• Sistemas internos
• Plataformas de terceros

A continuación te explicamos cómo comenzar a utilizarla paso a paso.

PASO 1

¿Para qué puedo usar la API de LoyaltyPro?

La API permite que tu sistema interactúe directamente con LoyaltyPro para automatizar procesos y mantener sincronizada la información de tus clientes y recompensas.

Algunas de las operaciones más comunes son:

• Consultar información de socios
• Registrar puntos
• Registrar punch (estrellas)
• Consultar saldo de puntos
• Validar usuarios
• Integrar promociones o recompensas

Por ejemplo, tu punto de venta puede otorgar puntos automáticamente cuando un cliente realiza una compra.

Ejemplo de uso

GET /v2/Socios/Consultar
Authorization: Bearer TU_TOKEN

Respuesta:

{
  "Nombre": "Juan Perez",
  "Telefono": "6141234567",
  "Puntos": 350
}

PASO 2

Obtener tu Token de acceso

Antes de poder utilizar la API necesitas generar tu Token de autenticación. Este token es la llave que permitirá que tu sistema se comunique con los servidores de LoyaltyPro.

Para generarlo:

1. Ingresa a tu Perfil de usuario dentro de la plataforma.
2. Busca la sección Token de API.
3. Copia el token generado.

Este token deberá enviarse en todas las solicitudes a la API.

Ejemplo de uso del token

Authorization: Bearer TU_TOKEN

PASO 3

¿Qué es el Token?

El Token es una cadena única que sirve para autenticar las solicitudes que se envían a la API.

Este token permite identificar:

• Empresa
• Usuario
• Sucursal

Gracias a esto, el sistema sabe desde qué cuenta se está realizando cada operación.

Importante

Mantén tu token seguro. Cualquier persona con acceso a él podría realizar operaciones dentro de tu cuenta. Si sospechas que tu token fue comprometido, puedes desactivarlo, generar uno nuevo y revisar su historial de uso.

PASO 4

Documentación interactiva de la API (Swagger)

Toda la documentación técnica de la API se encuentra disponible en Swagger, una herramienta que permite explorar y probar los endpoints de forma interactiva.

En Swagger podrás:

• Ver todos los endpoints disponibles
• Revisar los parámetros requeridos
• Consultar ejemplos de respuesta
• Ejecutar pruebas en tiempo real
• Validar tus integraciones antes de implementarlas

Esto facilita el trabajo de desarrollo, ya que podrás comprender cómo funciona cada endpoint directamente desde el navegador.

PASO 5

Explorar la API en Swagger

Una vez que ya cuentas con tu token de acceso y conoces cómo funciona la documentación interactiva, ya puedes entrar al portal de Swagger para comenzar a explorar y probar los endpoints disponibles.

Desde ahí podrás:

• Probar endpoints
• Enviar solicitudes reales
• Ver las respuestas del servidor
• Comprender cómo integrar LoyaltyPro en tu sistema

Buenas prácticas de integración

• Mantén tu token seguro
• Maneja correctamente los errores HTTP
• No envíes solicitudes innecesarias
• Utiliza HTTPS en todas tus integraciones