Integración de plataforma de Fidelización clientes en Glop

Requisitos:

La licencia con el módulo Fidelización API y la integración necesaria. Configurar la integración en el propio Glop.
Acceso a la propia plataforma de la integración.

Configuración desde Glop:

La configuración en Glop se llevará a cabo en la sección de terminales, dentro de la pestaña «Módulos/API/Fidelización» en su apartado correspondiente.

Simplemente, será necesario marcar la casilla de verificación para activar la integración e introducir el número de API KEY proporcionado por la integración.

Caso de uso:

Un cliente realiza un ticket en Glop
1. Si el cliente cuenta con usuario verificado en la plataforma integradora:
  - Se mostrará un cuadro con la información de fidelización del usuario, incluyendo el total de puntos acumulados y los cupones disponibles para aplicar.
2. Si el cliente no cuenta con usuario en la plataforma integradora:
  - Se creará un usuario en la plataforma, el cual no podrá ser utilizado hasta que se acepten los términos y condiciones de la integración.
A continuación, se podrá seleccionar el cupón a aplicar y finalizar el cobro del ticket, el descuento se aplicará de manera equitativa a cada artículo que componga el ticket.

Endpoints necesarios para la integración con GLOP

Algunos endpoints requieren el parámetro apikey en la cabecera o URL. Este parámetro será único en todas las llamadas realizadas por nuestros terminales a la API de terceros, independientemente del establecimiento que realice la llamada. Los establecimientos se «registrarán» y se «gestionarán» a través del listado de localizaciones y terminales en nuestra configuración de la API.

Obtener cliente mediante teléfono móvil:

Descripción

Obtenemos el cliente desde Glop mediante el número de teléfono introducido en la pantalla de cobro.

Estructura endpoint a sistema externo de fidelización

GET https://{externalfidelityintegration}/members/{phone}/

phone: Número de teléfono del cliente.
User-id: Id del empleado, situado en la cabecera.

Ejemplo respuesta del sistema externo de fidelización

{
    "card_url": "https://{externalfidelityintegration}/cards/8994987/",
    "member_summary": "Manolo Vidal\nNivel : Silver\nSaldo : 131 Puntos",
    "available_vouchers": [
        {
            "url": "https://{externalfidelityintegration}/vouchers/4WYYL0V/",
            "name": "Recompensa de fidelidad 5€",
            "value": "5.00",
            "unit": "Euros",
            "code": "4WYYL0V",
            "expiration_date": "2024-08-05T23:59:59",
            "external_id": null,
            "external_ids": [],
            "minimum_amount": null
        },    
    ]
}

Enviar ticket:

Descripción

Envío de ticket desde glop a la plataforma de fidelización.

Estructura endpoint a sistema externo de fidelización

curl --location 'https://{{externalfidelityintegration}}/visits/' \
--header 'Authorization: Token 21cdf0f6d1bb74be924e02ed9f27817a94b9173f' \
--header 'User-Agent: GlopApiRest/1.0' \
--header 'User-id: 10111' \
--header 'Content-Type: application/json' \
--data '{
    "card": "https://{{externalfidelityintegration}}/cards/2176232/",
    "price": "100.00",
    "details": {
        "items": [
            {
                "reference": "ABC",
                "name": "Product Name",
                "category": "XYZ",
                "unit_price": "100.00",
                "quantity": "1",
                "total_price": "100.00"
            }
        ]
    },
    "used_vouchers": []
}'

User-id: Id del empleado, situado en la cabecera.

Ejemplo respuesta del sistema externo de fidelización

{
    "url": "https://{{externalfidelityintegration}}/visits/27755860/",
    "card": {
        "url": "https://{{externalfidelityintegration}}/cards/8994987/",
        "id": 8994987,
        "reference": "8994987",
        "points_balance": "31.00",
        "owner_info": "M. VIDAL / SILVE",
        "program_info": {
            "program_id": 6175,
            "program_name": "Standard",
            "program_type": "CYCLE",
            "program_description": "",
            "dashboard_url": "https://{{externalfidelityintegration}}/4865/clients/5224#/customer/RGFzaGJvYXJkc0N1c3RvbWVyTm9kZToxMjA4NzE0Mg=="
        },
        "sponsor_code": null,
        "latent_points_balance": "0",
        "terms_accepted": true
    },
    "date": "2024-06-19T14:44:11+02:00",
    "price": "100.000",
    "details": {
        "items": [
            {
                "reference": "ABC",
                "name": "Product Name",
                "category": "XYZ",
                "unit_price": "100.00",
                "quantity": "1",
                "total_price": "100.00"
            }
        ]
    },
    "comment": null,
    "reference": "27755860",
    "used_vouchers": [],
    "cashback_withdraw_value": null,
    "message": "Merci pour votre fidélité. \r\nNouveau solde : 31\r\n",
    "customer_screen_url": null
}

Cancelar ticket

Estructura endpoint a sistema externo de fidelización

curl --location --globoff --request GET'https://{{externalfidelityintegration}}/visits/{{referencia}}' \
--header 'Authorization: Token 21cdf0f6d1bb74be924e02ed9f27817a94b9173f' \
--header 'User-Agent: GlopApiRest/1.0' \
--header 'User-id: 10111' \

referencia: Referencia del ticket el cual se va a cancelar.
User-id: Id del empleado, situado en la cabecera.

Ejemplo respuesta del sistema externo de fidelización

{
    "visit": "Le passage avec l'ID 27755860 a été annulé. Les récompenses et les points associé ont eux aussi été annulés"
}

Resumen:

Este documento proporciona información detallada sobre la integración con GLOP para la fidelización de clientes.

Se requiere una licencia de Glop y la configuración del módulo de integración en el apartado Módulos/API/Fidelización.
Se describe el caso de uso de la realización de un cobro asignado a un cliente de fidelización y a un cliente no fidelizado.
Se presentan varios endpoints necesarios para la integración con GLOP, como obtener cliente, enviar ticket y cancelar ticket.
Se detalla la estructura de los endpoints, ejemplos de respuestas y la importancia de ciertos parámetros como el User-id.