Programa de fidelización

Programa de fidelización

Introducción

Este endpoint del Webservice permite, desde plataformas externas, realizar la consulta y gestión de los miembros del programa de fidelización, su membresía, sus puntos, productos y canjeos realizados. Para el uso de este endpoint es necesario conocer el documento de identidad del miembro del programa de fidelización (DNI, NIE o pasaporte) y pasar el valor de dicho parámetro en la URL de la petición.

Casos de uso

Este endpoint tiene como finalidad principal la consulta y gestión de información sobre la membresía de un contacto de Fideltour desde fuera de la plataforma. Por ejemplo, resulta de gran utilidad en los siguientes contextos:
  1. Operativa de recepción: mediante la integración de Fideltour con el PMS utilizado por el equipo de recepción, los integrantes de este departamento pueden realizar la consulta de la membresía de un huésped y sus últimas operaciones directamente desde su ficha de contacto en el PMS, su herramienta de trabajo habitual, sin la necesidad de acceder a Fideltour ni tener nociones de uso de la misma. También pueden realizar el canjeo de productos adquiridos por el huésped a través del programa de fidelización de Fideltour y añadir o redimir puntos de forma manual.
  2. Proceso de reserva: el uso de este WS por parte de los motores de reserva permite a estas plataformas ofrecer diversas tarifas según la membresía del usuario final o incluso utilizar los puntos disponibles por el mismo para el pago de estancias en los establecimientos de sus clientes.

Información de membresía

Método API REST para la consulta del detalle de la membresía de los usuarios del programa de fidelización.

Métodos disponibles

  1. GET: Obtiene detalles del miembro por su número de identificación

URL de la petición

Ejemplo

GET: /api/public/v1/members/999000999/ HTTP/1.1

HOST: backend.fideltour.com
content-type: application/json
Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx


Respuesta
{
    "identification_number": "999000999",
    "points": 60,
    "level": {
        "title": "Platinum",
        "required_points": 0,
        "bonus_point_percent": 17.0,
        "is_active": true
    }
}

Redención de puntos

Permite redimir puntos a un miembro del programa siempre y cuando tenga suficientes puntos disponibles. A la hora de realizar la petición se debe incluir, en el cuerpo de la solicitud, la cantidad de puntos a redimir y el concepto que figurará en dicha operación.

Métodos disponibles

  1. POST: Crea una nueva redención de puntos a un miembro del programa de fidelización

URL de la petición


Tabla de parámetros

Parámetro
Tipo
Oblig.
Descripción
points
Numérico
Puntos a redimir
concept
Cadena de caracteres
Concepto de la operación

Ejemplo

POST: /api/public/v1/members/999000999/redeem-points/ HTTP/1.1

HOST: backend.fideltour.com
Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
{
"points": 20,
"concept": "Quitamos 20 puntos"
}

Respuesta
{
    "id": 248573,
    "product": null,
    "points": -20,
    "expired_points": null,
    "consumed_points": -20,
    "remaining_points": 0,
    "bonus_points": "0.00",
    "timestamp": "2020-11-04T08:03:18.191277",
    "concept": "Quitamos 20 puntos",
    "code": "DEBD018526",
    "redeemed": 0,
    "expired_date": "2020-11-04T08:03:18.143281",
    "book": null,
    "manager": 63
}

Añadido de puntos

Permite añadir un nuevo bloque de puntos puntos a un miembro del programa. A la hora de realizar la petición se debe incluir, en el cuerpo de la solicitud, la cantidad de puntos a añadir y el concepto que figurará en dicha operación.

Métodos disponibles

  1. POST: Añade un nuevo bloque de puntos a un miembro del programa de fidelización

URL de la petición


Tabla de parámetros

ParámetroTipoOblig.Descripción
pointsNuméricoPuntos a añadir
conceptCadena de caracteresConcepto de la operación

Ejemplo

POST: /api/public/v1/members/999000999/add-points/ HTTP/1.1

HOST: backend.fideltour.com
Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
{
"points": 20,
"concept": "Añadimos 20 puntos"
}

Respuesta
{
    "id": 248572,
    "product": null,
    "points": 20,
    "expired_points": null,
    "consumed_points": 0,
    "remaining_points": 20,
    "bonus_points": "0.00",
    "timestamp": "2020-11-04T08:02:46.996951",
    "concept": "añadimos 20 puntos",
    "code": "2F7906E640",
    "redeemed": 0,
    "expired_date": "2020-11-04T08:02:46.950143",
    "book": null,
    "manager": 63
}

Consulta de operaciones

Permite realizar una consulta de las operaciones realizadas para un miembro concreto del programa de fidelización. Opcionalmente es posible incluir, en el cuerpo de la solicitud, un parámetro para filtrar el tipo de operación que se desea recuperar.

Métodos disponibles

  1. GET: Obtiene un listado con el detalle de las operaciones realizadas para un miembro del programa

URL de la petición


Tabla de parámetros

ParámetroTipoOblig.Descripción
redeemedNuméricoNo
0 = No canjeable
1 = Canjeado
2 = No canjeado

Ejemplo

GET: /api/public/v1/members/999000999/operations/ HTTP/1.1

HOST: backend.fideltour.com
Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Respuesta
[
    {
        "id": 248573,
        "product": null,
        "points": -20,
        "expired_points": null,
        "consumed_points": -20,
        "remaining_points": 0,
        "bonus_points": "0.00",
        "timestamp": "2020-11-04T08:03:18.191277",
        "concept": "Quitamos 20 puntos",
        "code": "DEBD018526",
        "redeemed": 0,
        "expired_date": "2020-11-04T08:03:18.143281",
        "book": null,
        "manager": 63
    },
    {
        "id": 248570,
        "product": {
            "id": 1,
            "category": 0,
            "title": "Pop-up days 2018",
            "description": "Disfruta de 2 desayunos gratis en cualquiera de nuestros hoteles.",
            "points": 20,
            "is_active": true,
            "featured": true,
            "start_date": "2018-01-26",
            "end_date": "2021-12-31",
            "code": "8541263",
            "conditions": "Ninguna",
            "is_visible": true,
            "promocode": null,
            "notify_alert_emails": false,
            "hotel_chain": 1,
            "hotel": 1,
            "levels": []
        },
        "points": -20,
        "expired_points": null,
        "consumed_points": -20,
        "remaining_points": 0,
        "bonus_points": "0.00",
        "timestamp": "2020-11-03T08:36:30.117605",
        "concept": "Pop-up days 2018",
        "code": "2859ADD5FB",
        "redeemed": 2,
        "expired_date": null,
        "book": null,
        "manager": null
    }
]

Ejemplo con filtro

En el siguiente ejemplo se muestra una solicitud para consultar las operaciones no canjeadas de un miembro del club con el documento de identidad número "999000999".

GET: /api/public/v1/members/999000999/operations/?redeemed=2 HTTP/1.1


HOST: backend.fideltour.com
content-type: application/json

Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx


Respuesta
[
    {
        "id": 248570,
        "product": {
            "id": 1,
            "category": 0,
            "title": "Pop-up days 2018",
            "description": "Disfruta de 2 desayunos gratis en cualquiera de nuestros hoteles.",
            "points": 20,
            "is_active": true,
            "featured": true,
            "start_date": "2018-01-26",
            "end_date": "2021-12-31",
            "code": "8541263",
            "conditions": "Ninguna",
            "is_visible": true,
            "promocode": null,
            "notify_alert_emails": false,
            "hotel_chain": 1,
            "hotel": 1,
            "levels": []
        },
        "points": -20,
        "expired_points": null,
        "consumed_points": -20,
        "remaining_points": 0,
        "bonus_points": "0.00",
        "timestamp": "2020-11-03T08:36:30.117605",
        "concept": "Pop-up days 2018",
        "code": "2859ADD5FB",
        "redeemed": 2,
        "expired_date": null,
        "book": null,
        "manager": null
    }
]

Canjeo de operaciones

Cuando un miembro del programa de fidelización realiza la compra de un producto desde la plataforma de Fideltour se le retiran los puntos pertinentes y se le añade un nuevo bloque a su histórico de movimientos de puntos relacionado con dicha compra y pendiente de canjear. Cuando dicho bloque de puntos es canjeado, se entiende que el miembro ha disfrutado del producto adquirido con sus puntos. Los distintos equipos de operaciones pueden indicar, en el momento en el que el huésped solicita el disfrute de este producto, el canjeo del mismo en la plataforma para evitar que dicho producto sea disfrutado dos veces por el huésped.

Métodos disponibles

  1. POST: Permite canjear un producto adquirido por un miembro del programa

URL de la petición


Tabla de parámetros

ParámetroTipoOblig.Descripción
operation_idNuméricoID de la operación a canjear

Ejemplo

POST: /api/public/v1/members/999000999/redeem-operation/ HTTP/1.1

HOST: backend.fideltour.com
content-type: application/json
Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
{
"operation_id": 248570
}

Respuesta
{
    "id": 248570,
    "product": {
        "id": 1,
        "category": 0,
        "title": "Pop-up days 2018",
        "description": "Disfruta de 2 desayunos gratis en cualquiera de nuestros hoteles.",
        "points": 20,
        "is_active": true,
        "featured": true,
        "start_date": "2018-01-26",
        "end_date": "2021-12-31",
        "code": "8541263",
        "conditions": "Ninguna",
        "is_visible": true,
        "promocode": null,
        "notify_alert_emails": false,
        "hotel_chain": 1,
        "hotel": 1,
        "levels": []
    },
    "points": -20,
    "expired_points": null,
    "consumed_points": -20,
    "remaining_points": 0,
    "bonus_points": "0.00",
    "timestamp": "2020-11-03T08:36:30.117605",
    "concept": "Pop-up days 2018",
    "code": "2859ADD5FB",
    "redeemed": 1,
    "expired_date": null,
    "book": null,
    "manager": null
}

    • Related Articles

    • Gestión de reservas

      Introducción Este endpoint del Webservice permite la creación y actualización de reservas asociadas a contactos en Fideltour de forma externa. La URL de este Webservice es:  https://backend.fideltour.com/api/3rd-party/bookings/ Casos de uso Las ...
    • Conexiones de entrada

      Introducción Este endpoint del Webservice permite incorporar en Fideltour movimientos de conexión realizados desde plataformas de terceros. La URL de este Webservice es:  https://backend.fideltour.com/api/3rd-party/entries/ Casos de uso En muchas ...
    • Introducción

      Presentación Bienvenido a la documentación de la API pública de Fideltour, una API para la comunicación entre Fideltour y otras aplicaciones como motores de reservas, PMS, plataformas de gestión de contenidos, portales WiFi, etc. Esta guía se centra ...
    • Gestión de contactos

      Introducción Este endpoint del Webservice permite la creación y actualización de fichas de contacto en Fideltour de forma externa. La URL de este Webservice es: https://backend.fideltour.com/api/3rd-party/contacts/ Casos de uso El endpoint para la ...
    • Formularios de suscripción

      Introducción En el presente documento se describen los pasos a seguir para la implementación del formulario de suscripción de contactos de Fideltour en su página web. Es esencial el cumplimiento minucioso de las especificaciones que se describen para ...