--- title: Fidelización slug: fidelizacion description: Learn how to generate an API Key and Audit-Key for Mobbex's loyalty module in this comprehensive document. Discover essential guidelines for point loading, card number limitations, and authorization for adding points. Explore code examples in various prog icon: {"faIcon":"fa-brands fa-octopus-deploy"} docTags: createdAt: 2021-01-25T14:28:16.000Z --- 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 :::BlockQuote https\://api.mobbex.com/p/loyalty ::: ### Cabeceras (Headers) - **x-api-key**: Clave API de su aplicación - **x-audit-key**: Clave de Auditoria ## Servicios :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.mobbex.com/p/loyalty/accounts/search", "name": "Búsqueda de Cuenta", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación" }, { "kind": "required", "name": "x-audit-key", "type": "string", "description": "Clave de Auditoria" } ], "bodyDataParameters": [ { "kind": "required", "name": "reference", "type": "string", "description": "Referencia a buscar, puede ser un DNI, una credencial, un email o un Nombre" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "keTMYugDLpc-PqpOk18WP", "code": "{\n \"result\": true,\n \"data\": [\n {\n \"uid\": \"ght12s_SQ\",\n \"credential\": \"45485\",\n \"name\": \"Demo Mobbex\",\n \"identification\": \"12123123\",\n \"email\": \"demo@mobbex.com\",\n \"phone\": \"\",\n \"customer\": {\n \"_id\": \"4a6ad3cf120790ab0f8b2b49\",\n \"name\": \"Demo Mobbex\",\n \"email\": \"demo@mobbex.com\",\n \"identification\": \"12123123\",\n \"phone\": \"\"\n },\n \"balance\": 150,\n \"account\": \"4a6ad3cf120790ab0f8b2b49\"\n }\n ]\n}", "language": "200" } ], "selectedLanguageId": "keTMYugDLpc-PqpOk18WP" }, "examples": { "languages": [ { "id": "aCr4sJOcKspNuVRuwYwkt", "code": "var client = new RestClient(\"https://api.mobbex.com/p/loyalty/accounts/search\");\r\nclient.Timeout = -1;\r\nvar request = new RestRequest(Method.POST);\r\nrequest.AddHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\r\nrequest.AddHeader(\"x-audit-key\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\r\nrequest.AddHeader(\"Content-Type\", \"application/json\");\r\nrequest.AddParameter(\"application/json\", \"{\\r\\n \\\"reference\\\": \\\"45485\\\"\\r\\n}\", ParameterType.RequestBody);\r\nIRestResponse response = client.Execute(request);\r\nConsole.WriteLine(response.Content);", "language": "csharp" }, { "id": "dvG0KL38_85yQlCnkMMnV", "code": "curl --location --request POST 'https://api.mobbex.com/p/loyalty/accounts/search' \\\r\n--header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \\\r\n--header 'x-audit-key: d31f0721-2f85-44e7-bcc6-15e19d1a53cc' \\\r\n--header 'Content-Type: application/json' \\\r\n--data-raw '{\r\n \"reference\": \"45485\"\r\n}'", "language": "curl" }, { "id": "UK5YenHFBdRxydYjO8ILm", "code": "var data = JSON.stringify({\n \"reference\": \"45485\"\n});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.mobbex.com/p/loyalty/accounts/search\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-audit-key\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "YGs3dz_4F7fSJ1GK-bOo6", "code": " 'https://api.mobbex.com/p/loyalty/accounts/search',\r\n CURLOPT_RETURNTRANSFER => true,\r\n CURLOPT_ENCODING => '',\r\n CURLOPT_MAXREDIRS => 10,\r\n CURLOPT_TIMEOUT => 0,\r\n CURLOPT_FOLLOWLOCATION => true,\r\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\r\n CURLOPT_CUSTOMREQUEST => 'POST',\r\n CURLOPT_POSTFIELDS =>'{\r\n \"reference\": \"45485\"\r\n}',\r\n CURLOPT_HTTPHEADER => array(\r\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-audit-key: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',\r\n 'Content-Type: application/json'\r\n ),\r\n));\r\n\r\n$response = curl_exec($curl);\r\n\r\ncurl_close($curl);\r\necho $response;\r\n", "language": "php" } ], "selectedLanguageId": "aCr4sJOcKspNuVRuwYwkt" }, "description": "Importante: se debe limitar la cantidad de consultas generadas al server ya que de lo contrario el IP podrá ser bloqueado.", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "bsqueda-de-cuenta", "legacyHash": "WOG3vLMR34sUkBITeGwgx" } ``` ::: :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.mobbex.com/p/loyalty/accounts/create", "name": "Creación de Cuenta", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación" }, { "kind": "required", "name": "x-audit-key", "type": "string", "description": "Clave de Auditoria" } ], "bodyDataParameters": [ { "kind": "required", "name": "identification", "type": "string", "description": "DNI del usuario." }, { "kind": "required", "name": "email", "type": "string", "description": "Email del usuario." }, { "kind": "optional", "name": "credential", "type": "string", "description": "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." }, { "kind": "optional", "name": "name", "type": "string", "description": "Nombre del usuario." }, { "kind": "optional", "name": "phone", "type": "string", "description": "Teléfono del usuario." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "AR2FNFvTXqw0uwYFSnxr7", "code": "", "language": "200" } ], "selectedLanguageId": "AR2FNFvTXqw0uwYFSnxr7" }, "examples": { "languages": [ { "id": "MMVlVsehHtb6wHvGJsEsV", "code": "var client = new RestClient(\"https://api.mobbex.com/p/loyalty/accounts/create\");\r\nclient.Timeout = -1;\r\nvar request = new RestRequest(Method.POST);\r\nrequest.AddHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\r\nrequest.AddHeader(\"x-audit-key\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\r\nrequest.AddHeader(\"Content-Type\", \"application/json\");\r\nrequest.AddParameter(\"application/json\", \"{\\r\\n \\\"identification\\\": \\\"12123123\\\",\\r\\n \\\"email\\\": \\\"demo@mobbex.com\\\",\\r\\n \\\"credential\\\": \\\"000123\\\",\\r\\n \\\"name\\\": \\\"Cliente Demo\\\"\\r\\n}\", ParameterType.RequestBody);\r\nIRestResponse response = client.Execute(request);\r\nConsole.WriteLine(response.Content);", "language": "csharp" }, { "id": "T6tpy60PRmXtGQoCIic2B", "code": "var data = JSON.stringify({\n \"identification\": \"12123123\",\n \"email\": \"demo@mobbex.com\",\n \"credential\": \"000123\",\n \"name\": \"Cliente Demo\"\n});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.mobbex.com/p/loyalty/accounts/create\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-audit-key\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "vDFRbLlqtXxp1S6G1CMxW", "code": " 'https://api.mobbex.com/p/loyalty/accounts/create',\r\n CURLOPT_RETURNTRANSFER => true,\r\n CURLOPT_ENCODING => '',\r\n CURLOPT_MAXREDIRS => 10,\r\n CURLOPT_TIMEOUT => 0,\r\n CURLOPT_FOLLOWLOCATION => true,\r\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\r\n CURLOPT_CUSTOMREQUEST => 'POST',\r\n CURLOPT_POSTFIELDS =>'{\r\n \"identification\": \"12123123\",\r\n \"email\": \"demo@mobbex.com\",\r\n \"credential\": \"000123\",\r\n \"name\": \"Cliente Demo\"\r\n}',\r\n CURLOPT_HTTPHEADER => array(\r\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-audit-key: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',\r\n 'Content-Type: application/json'\r\n ),\r\n));\r\n\r\n$response = curl_exec($curl);\r\n\r\ncurl_close($curl);\r\necho $response;\r\n", "language": "php" } ], "selectedLanguageId": "MMVlVsehHtb6wHvGJsEsV" }, "description": "Permite crear una nueva credencial dentro del servicio de fidelización", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "creacin-de-cuenta", "legacyHash": "mP_tVx0Vxd36Ny61Xw8Oe" } ``` ::: *Importante:* los datos opcionales a pesar de ser, justamente opcionales, deberían ser completados siempre que sea posible. :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.mobbex.com/p/loyalty/accounts/balance", "name": "Balance de Cuenta", "method": "GET", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación" }, { "kind": "required", "name": "x-audit-key", "type": "string", "description": "Clave de auditoría." } ], "bodyDataParameters": [ { "kind": "required", "name": "credential", "type": "string", "description": "Número de credencial obtenido usando la búsqueda." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "22jGA6KHQlW5K2bR9V2za", "code": "{\r\n \"result\": true,\r\n \"data\": {\r\n \"balance\": 16,\r\n \"user\": {\r\n \"name\": \"Cliente Demo\"\r\n }\r\n }\r\n}", "language": "200" } ], "selectedLanguageId": "22jGA6KHQlW5K2bR9V2za" }, "examples": { "languages": [ { "id": "5ZJXeqDn7ILHB1uGDcu48", "code": "var client = new RestClient(\"https://api.mobbex.com/p/loyalty/accounts/balance\");\r\nclient.Timeout = -1;\r\nvar request = new RestRequest(Method.POST);\r\nrequest.AddHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\r\nrequest.AddHeader(\"x-audit-key\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\r\nrequest.AddHeader(\"Content-Type\", \"application/json\");\r\nrequest.AddParameter(\"application/json\", \"{\\r\\n \\\"credential\\\": \\\"45485\\\"\\r\\n}\", ParameterType.RequestBody);\r\nIRestResponse response = client.Execute(request);\r\nConsole.WriteLine(response.Content);", "language": "csharp" }, { "id": "JAPjLkkdo4ZiKpr9lB52f", "code": "var data = JSON.stringify({\n \"credential\": \"45485\"\n});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.mobbex.com/p/loyalty/accounts/balance\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-audit-key\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "UHlXpepDiF5EQm-aHv10K", "code": " 'https://api.mobbex.com/p/loyalty/accounts/balance',\r\n CURLOPT_RETURNTRANSFER => true,\r\n CURLOPT_ENCODING => '',\r\n CURLOPT_MAXREDIRS => 10,\r\n CURLOPT_TIMEOUT => 0,\r\n CURLOPT_FOLLOWLOCATION => true,\r\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\r\n CURLOPT_CUSTOMREQUEST => 'POST',\r\n CURLOPT_POSTFIELDS =>'{\r\n \"credential\": \"45485\"\r\n}',\r\n CURLOPT_HTTPHEADER => array(\r\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-audit-key: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',\r\n 'Content-Type: application/json'\r\n ),\r\n));\r\n\r\n$response = curl_exec($curl);\r\n\r\ncurl_close($curl);\r\necho $response;\r\n", "language": "php" } ], "selectedLanguageId": "5ZJXeqDn7ILHB1uGDcu48" }, "description": "", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "balance-de-cuenta", "legacyHash": "9kR6Q8xKMlIe5p3E10b6z" } ``` ::: :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.mobbex.com/p/loyalty/points/charge", "name": "Carga de Puntos", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-audit-key", "type": "string", "description": "Clave de auditoría." } ], "bodyDataParameters": [ { "kind": "required", "name": "credential", "type": "string", "description": "Número de credencial obtenido usando la búsqueda." }, { "kind": "required", "name": "tax_id", "type": "string", "description": "CUIT de la Entidad que realiza la carga de Puntos. Debe ser una Entidad válida y asociada al Operador." }, { "kind": "required", "name": "points", "type": "Integer", "description": "Cantidad de puntos a cargar en la cuenta." }, { "kind": "required", "name": "reference", "type": "string", "description": "Referencia de la operación de carga." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "17ZBAgpRFn82U3yEHO6G7", "code": "", "language": "200" } ], "selectedLanguageId": "17ZBAgpRFn82U3yEHO6G7" }, "examples": { "languages": [ { "id": "5ccW0a8q3fLrTbeB7xHs2", "code": "var client = new RestClient(\"https://api.mobbex.com/p/loyalty/points/charge\");\r\nclient.Timeout = -1;\r\nvar request = new RestRequest(Method.POST);\r\nrequest.AddHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\r\nrequest.AddHeader(\"x-audit-key\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\r\nrequest.AddHeader(\"Content-Type\", \"application/json\");\r\nrequest.AddParameter(\"application/json\", \"{\\r\\n \\\"credential\\\": \\\"45485\\\",\\r\\n \\\"tax_id\\\": \\\"99999999999\\\",\\r\\n \\\"point\\\": 10,\\r\\n \\\"reference\\\": \\\"Carga de punto al cliente DEMO\\\"\\r\\n}\", ParameterType.RequestBody);\r\nIRestResponse response = client.Execute(request);\r\nConsole.WriteLine(response.Content);", "language": "csharp" }, { "id": "yJUFxUpVKLNK_LtqesMAn", "code": "var data = JSON.stringify({\n \"credential\": \"45485\",\n \"tax_id\": \"99999999999\",\n \"point\": 10,\n \"reference\": \"Carga de punto al cliente DEMO\"\n});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.mobbex.com/p/loyalty/points/charge\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-audit-key\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "v_Gaedv_XUMorRXlVn9gw", "code": " 'https://api.mobbex.com/p/loyalty/points/charge',\r\n CURLOPT_RETURNTRANSFER => true,\r\n CURLOPT_ENCODING => '',\r\n CURLOPT_MAXREDIRS => 10,\r\n CURLOPT_TIMEOUT => 0,\r\n CURLOPT_FOLLOWLOCATION => true,\r\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\r\n CURLOPT_CUSTOMREQUEST => 'POST',\r\n CURLOPT_POSTFIELDS =>'{\r\n \"credential\": \"45485\",\r\n \"tax_id\": \"99999999999\",\r\n \"point\": 10,\r\n \"reference\": \"Carga de punto al cliente DEMO\"\r\n}',\r\n CURLOPT_HTTPHEADER => array(\r\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-audit-key: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',\r\n 'Content-Type: application/json'\r\n ),\r\n));\r\n\r\n$response = curl_exec($curl);\r\n\r\ncurl_close($curl);\r\necho $response;\r\n", "language": "php" } ], "selectedLanguageId": "5ccW0a8q3fLrTbeB7xHs2" }, "description": "Permite realizar la carga de puntos a una credencial específica.", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "carga-de-puntos", "legacyHash": "O9vJ15DC6otbDJMhBn9xb" } ``` ::: # Enpoints Restringidos Las siguientes rutas requieren de permisos especiales y no podrán ser consultadas utilizando el Audit-Key. ### Transacciones :::BlockQuote POST **https\://api.mobbex.com/p/loyalty/transactions** ::: **** **Parámetros** - `credential`: Número de credencial obtenido usando la búsqueda. ### Consumo de puntos :::BlockQuote 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. :::BlockQuote 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": "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": "juanperez@mobbex.com" }, "reference": "HyjdiK8Tx" } } } ```