MÓDULOS
Fidelización

15min
El API de fidelización a diferencia de otros API requiere de 2 niveles de Claves de acceso al servicio debido a que el mismo es un servicio operado y auditado. A continuación se explica cómo generar un API Key para acceder a Mobbex y cómo obtener el Audit-Key para acceder al módulo de fidelización.
Audit-Key: clave de auditoria
Para crear una clave de auditoria debería generar su empresa en Mobbex, para ello luego de haber creado la cuenta en el punto anterior, dirijase a "Crear Entidad", ingrese su CUIT y valide los datos. Una vez que la entidad se encuentre creada provea su CUIT a la entidad operadora para que asocie su cuenta y genere su Audit-Key. Una vez asociado a la entidad operadora podrá ver en su consola un nuevo item con su Clave de Auditoria.
Aclaraciones Generales
La carga de puntos no depende ni dependerá de los medios de pago provistos por Mobbex siendo responsabilidad del Sistema ( Entidad con Audit-Key ) la implementación de limitaciones en caso de que la implementación lo requiera.
Los números de Tarjeta no poseen ningún tipo de limitaciones de caracteres aunque se recomienda que posean un número mínimo de 4 digitos por cuestiones de no colisión aunque esto será gestionado exclusivamente por el Operador autorizado al uso del servicio.
La carga de puntos no es exclusiva de Entidades registradas en Mobbex pero si es exclusiva a la autorización del Operador. Los operadores deberán autorizar previamente a los CUIT que podrán sumar puntos mediante su sistema de fidelización utilizando la Consola de Mobbex.
Todas las entidades autorizadas por el Operador del sistema de Fidelización podrán sumar puntos en las credenciales emitidas.
URL del Servicio
https://api.mobbex.com/p/loyalty
Cabeceras (Headers)
x-api-key: Clave API de su aplicación
x-audit-key: Clave de Auditoria
Servicios
Importante: se debe limitar la cantidad de consultas generadas al server ya que de lo contrario el IP podrá ser bloqueado.
POST
Request
Header Parameters
x-api-key
required
String
Clave API de su aplicación
x-audit-key
required
String
Clave de Auditoria
Body Parameters
reference
required
String
Referencia a buscar, puede ser un DNI, una credencial, un email o un Nombre
﻿
Permite crear una nueva credencial dentro del servicio de fidelización
POST
Request
Header Parameters
x-api-key
required
String
Clave API de su aplicación
x-audit-key
required
String
Clave de Auditoria
Body Parameters
identification
required
String
DNI del usuario.
email
required
String
Email del usuario.
credential
optional
String
Número o Identificador de Credencial del usuario. Si no se provee un número de credencial el sistema creará una credencial virtual y retornará la misma.
name
optional
String
Nombre del usuario.
phone
optional
String
Teléfono del usuario.
﻿
Importante: los datos opcionales a pesar de ser, justamente opcionales, deberían ser completados siempre que sea posible.
GET
Request
Header Parameters
x-api-key
required
String
Clave API de su aplicación
x-audit-key
required
String
Clave de auditoría.
Body Parameters
credential
required
String
Número de credencial obtenido usando la búsqueda.
﻿
Permite realizar la carga de puntos a una credencial específica.
POST
Request
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-audit-key
required
String
Clave de auditoría.
Body Parameters
credential
required
String
Número de credencial obtenido usando la búsqueda.
tax_id
required
String
CUIT de la Entidad que realiza la carga de Puntos. Debe ser una Entidad válida y asociada al Operador.
points
required
Integer
Cantidad de puntos a cargar en la cuenta.
reference
required
String
Referencia de la operación de carga.
﻿
Enpoints Restringidos
Las siguientes rutas requieren de permisos especiales y no podrán ser consultadas utilizando el Audit-Key.
Transacciones
POST https://api.mobbex.com/p/loyalty/transactions
﻿
Parámetros
credential: Número de credencial obtenido usando la búsqueda.
Consumo de puntos
POST https://api.mobbex.com/p/loyalty/points/discharge
﻿
Parámetros
credential: Número de credencial obtenido usando la búsqueda.
points: Cantidad de puntos a consumir en la cuenta.
WebHooks
Los WebHooks son URLs seguras mediante las cual Mobbex notificará los diferentes eventos relacionados con el módulo de Fidelización.
Para configurar un WebHook debe hacerlo desde la consola de Mobbex en la sección Fidelización, Configuración. El WebHook debe ser HTTPS (TLS 1.2 o Superior) y debe poder recibir datos mediante el método POST de HTTP.
Tipos
Nueva Credencial
Nueva Operación
Nueva Credencial
Tipo POST
Formato JSON
JSON
{
    "type": "LOYALTY_CREDENTIAL",
    "data": {
        "uid": "r18WGnQmm",
        "credential": "a1b2c3d4",
        "name": "Juan Perez",
        "identification": "12123123",
        "email": "[email protected]"
    }
}
{
    "type": "LOYALTY_CREDENTIAL",
    "data": {
        "uid": "r18WGnQmm",
        "credential": "a1b2c3d4",
        "name": "Juan Perez",
        "identification": "12123123",
        "email": "juanperez@email.com"
    }
}
﻿
Nueva Operación
Tipo POST
Formato JSON
JSON
{
    "type": "LOYALTY_TRANSACTION",
    "data": {
        "result": true,
        "view": {
            "type": "card"
        },
        "payment": {
            "id": "rkWpX3YU6x",
            "status": {
                "code": "200",
                "text": "Paid",
                "message": "APROBADA"
            },
            "total": 10,
            "currency": {
                "code": "ARS",
                "text": "Peso Argentino"
            },
            "currency_data": {
                "value": "PTS",
                "label": "Puntos",
                "symbol": "$P"
            },
            "source": {
                "name": "Puntos",
                "type": "card",
                "number": "XXXXXXXXXXXX"
            },
            "user": {
                "name": "Juan Perez",
                "email": "[email protected]"
            },
            "reference": "HyjdiK8Tx"
        }
    }
}
{
    "type": "LOYALTY_TRANSACTION",
    "data": {
        "result": true,
        "view": {
            "type": "card"
        },
        "payment": {
            "id": "rkWpX3YU6x",
            "status": {
                "code": "200",
                "text": "Paid",
                "message": "APROBADA"
            },
            "total": 10,
            "currency": {
                "code": "ARS",
                "text": "Peso Argentino"
            },
            "currency_data": {
                "value": "PTS",
                "label": "Puntos",
                "symbol": "$P"
            },
            "source": {
                "name": "Puntos",
                "type": "card",
                "number": "XXXXXXXXXXXX"
            },
            "user": {
                "name": "Juan Perez",
                "email": "juanperez@mobbex.com"
            },
            "reference": "HyjdiK8Tx"
        }
    }
}
﻿
﻿
Updated 03 Mar 2023
Did this page help you?
Métodos de Pago y Cuotas
Códigos de Barra y QR