Documentación de la API

API REST de solo lectura. Disponible en el plan Pro.

Cómo obtener tu clave de API

Si tienes el plan Pro, ve a Panel → Ajustes → Acceso a la API y haz clic en Generar clave de API. Mantén esta clave en secreto — cualquier persona que la tenga puede leer los datos de fidelidad de tu negocio.

Autenticación

Cada solicitud debe incluir tu api_key como parámetro de consulta o campo del formulario. Las solicitudes sin una clave válida para un negocio con plan Pro devuelven:

{
  "response": {
    "error": "invalid_or_unauthorized_api_key"
  }
}

URL base

https://app.loyaltyloop.co/api/1.1/wf

Endpoints

GEThttps://app.loyaltyloop.co/api/1.1/wf/api_v1_summary

Estadísticas agregadas de tu negocio: número de tarjetas, clientes, sellos y recompensas, además de la tasa de canje.

Parámetros

api_key (obligatorio) — Tu clave de API.

Ejemplo de respuesta

{
  "response": {
    "cards_count": 42,
    "customers_count": 318,
    "stamps_count": 1204,
    "rewards_count": 87,
    "redemption_rate": 63
  }
}

GEThttps://app.loyaltyloop.co/api/1.1/wf/api_v1_cards

Lista todas las tarjetas de fidelidad de tu negocio.

Parámetros

api_key (obligatorio) — Tu clave de API.

Ejemplo de respuesta

{
  "response": {
    "cards": [
      { "_id": "...", "name": "Coffee Card", "stamps_required": 10 }
    ]
  }
}

GEThttps://app.loyaltyloop.co/api/1.1/wf/api_v1_customers

Lista todos los clientes que se han unido a una tarjeta de fidelidad de tu negocio.

Parámetros

api_key (obligatorio) — Tu clave de API.

Ejemplo de respuesta

{
  "response": {
    "customers": [
      { "_id": "...", "name": "Jane Doe", "phone": "+351..." }
    ]
  }
}

GEThttps://app.loyaltyloop.co/api/1.1/wf/api_v1_stamps

Lista los sellos recogidos en tu negocio, opcionalmente filtrados por rango de fechas.

Parámetros

api_key (obligatorio) — Tu clave de API.
start_date (opcional) — Fecha en formato ISO. Omite este parámetro para incluir todo el historial.
end_date (opcional) — Fecha en formato ISO. Omite este parámetro para incluir hasta la fecha actual.

Ejemplo de respuesta

{
  "response": {
    "stamps": [
      { "_id": "...", "Created Date": "2026-07-01T12:00:00Z" }
    ]
  }
}

GEThttps://app.loyaltyloop.co/api/1.1/wf/api_v1_rewards

Lista las recompensas emitidas en tu negocio, opcionalmente filtradas por estado.

Parámetros

api_key (obligatorio) — Tu clave de API.
status (opcional) — p. ej. "redeemed". Omite este parámetro para incluir todos los estados.

Ejemplo de respuesta

{
  "response": {
    "rewards": [
      { "_id": "...", "status": "redeemed" }
    ]
  }
}

Preguntas

Escribe a hello@loyaltyloop.co si tienes problemas al integrar la API.