Renault Le Club | API

Appearance

📋 Registro de Usuarios ​

Flujo de registro para los distintos tipos de usuarios de Renault Le Club.

🧠 Lógica de negocio ​

En el universo de Renault Le Club existen dos tipos de cuentas:

  • Titulares: usuario que crea una cuenta a través un chasis o un plan. Es el propietario real de la cuenta y, a nivel negocio, el dueño del vehículo (VIN/chasis) o plan de ahorro (plan/contrato).
  • Adicionales: usuario que es invitado por un Titular a gozar de los mismos beneficios que él. Como analogía, es la cuenta "hija" del Titular.

👨 Registrar a un titular ​

Dentro de dicho universo los titulares se categorizan dentro de tres tipos de usuario:

  • Propietarios: tienen uno o más vehículos y no tienen ningún plan de ahorro.
  • Ahorristas: tienen uno o más planes de ahorro y no tienen ningún vehículo.
  • Mixtos: tienen al menos un vehículo y un plan de ahorro.

Importante: si bien los usuarios inicialmente se registran con un único item (ya sea un vehículo o un plan de ahorro) una vez registrados tienen la potestad de agregar ítems adicionales desde su perfil. De esta forma es como un usuario Propietario o Ahorrista puede ser recategorizado a Mixto.

🚗 Registrar a un propietario ​

Los propietarios son los usuarios que se registran con un vehículo.

  • URL: /api/auth/register/titular/propietario
  • Método: POST

Request Body ​

json
{
    "documentType": 1,
    "documentNumber": "36364242",
    "firstname": "Goran API",
    "lastname": "Westberg API",
    "email": "goran.westberg@thalamuscorp.com",
    "password": "contraseñaFalsa1234!",
    "password_confirmation": "contraseñaFalsa1234!",
    "cellphoneAreaCode": "11",
    "cellphoneNumber": "12344321",
    "moreInfo": true,
    "vin": "PRUEBAGORAN123456",
    "carModel": "CLIO",
    "removeAsAdicional": true,
    "bir": 3200000,
    "captcha_token": "captchaToken",
}
CampoTipoRequeridoDescripciónRequerimientos
documentTypeInteger✔️ID del tipo de documentoPermitido: 1, 3
documentNumberString✔️Número de documento del usuario-
firstnameString✔️Nombre/Razón social del usuario-
lastnameString✖️Apellido del usuario-
emailString✔️Email del usuario-
passwordString✔️Contraseña del usuario-
password_confirmationString✔️Confirmación de la contraseña del usuario-
cellphoneAreaCodeString✔️Código de área del celular del usuario-
cellphoneNumberString✔️Número del celular del usuario-
moreInfoBoolean✔️Campo que indica si el usuario quiere recibir campañas de marketingVerdadero, Falso
vinString✔️Chasis del vehículo del usuario-
carModelString✔️Nombre del modelo del vehículo del usuario-
removeAsAdicionalBoolean✖️Campo que indica si el usuario debe ser eliminado como adicionalVerdadero, Falso
birInteger✖️Código del concesionario elegido por el usuario-
captcha_tokenString✔️Token de validación del captcha-

Response ​

json
{
    "success": true,
    "message": "Propietario registrado satisfactoriamente (Updated)",
    "data": null
}
json
{
    "success": false,
    "message": "El chasis pertenece a otro usuario",
}
json
{
    "success": false,
    "message": "El usuario ya está registrado en Renault Le Club",
}

💰 Registrar a un ahorrista ​

Los ahorristas son los usuarios que se registran con un plan de ahorros (plan/contrato).

  • URL: /api/auth/register/titular/ahorrista
  • Método: POST

Request Body ​

json
{
    "documentType": 1,
    "documentNumber": "36364242",
    "firstname": "Goran API",
    "lastname": "Westberg API",
    "email": "goran.westberg@thalamuscorp.com",
    "password": "contraseñaFalsa1234!",
    "password_confirmation": "contraseñaFalsa1234!",
    "cellphoneAreaCode": "11",
    "cellphoneNumber": "12344321",
    "moreInfo": true,
    "plan": "ABC123-A",
    "removeAsAdicional": true,
    "bir": 3200000,
    "captcha_token": "captchaToken",
}
CampoTipoRequeridoDescripciónRequerimientos
documentTypeInteger✔️ID del tipo de documentoPermitido: 1, 3
documentNumberString✔️Número de documento del usuario-
firstnameString✔️Nombre/Razón social del usuario-
lastnameString✖️Apellido del usuario-
emailString✔️Email del usuario-
passwordString✔️Contraseña del usuario-
password_confirmationString✔️Confirmación de la contraseña del usuario-
cellphoneAreaCodeString✔️Código de área del celular del usuario-
cellphoneNumberString✔️Número del celular del usuario-
moreInfoBoolean✔️Campo que indica si el usuario quiere recibir campañas de marketingVerdadero, Falso
planString✔️Número de Plan del usuario-
removeAsAdicionalBoolean✖️Campo que indica si el usuario debe ser eliminado como adicionalVerdadero, Falso
birInteger✖️Código del concesionario elegido por el usuario-
captcha_tokenString✔️Token de validación del captcha-

Response ​

json
{
    "success": true,
    "message": "Ahorrista registrado satisfactoriamente (Registered)",
    "data": null
}
json
{
    "success": false,
    "message": "El contrato pertenece a otro usuario",
}
json
{
    "success": false,
    "message": "El usuario ya está registrado en Renault Le Club",
}

👦 Registrar a un adicional ​

Los adicionales son personas autorizadas a consumir los mismos beneficios que su titular. Un titular tiene la potestad de agregar un solo adicional a su cuenta. Para verlo de alguna forma, los adicionales son los hijos de los titulares su registro. Un titular debe invitar a un adicional y este último debe posteriormente concretar

📨 Invitar a un adicional ​

Esta es la primera etapa de creación de un adicional, donde un titular invita a una persona no registrada en la aplicación a registrarse como adicional y lo marca como tal en la base de datos.

  • URL: /api/user/additional
  • Método: POST

Request Body ​

json
{
    "documentType": 1,
    "documentNumber": "44640896",
    "firstname": "Goran",
    "lastname": "Westberg",
    "email": "goran.westberg@thalamuscorp.com"
}
CampoTipoRequeridoDescripciónRequerimientos
documentTypeInteger✔️ID del tipo de documentoPermitido: 1, 3
documentNumberString✔️Número de documento del usuario-
firstnameString✔️Nombre/Razón social del usuario-
lastnameString✖️Apellido del usuario-
emailString✔️Email del usuario-

Response ​

json
{
    "success": true,
    "message": "Adicional invitado exitosamente",
    "data": null
}
json
{
    "success": false,
    "message": "El usuario ya está registrado en Renault Le Club",
}
json
{
    "success": false,
    "message": "El titular para el que se está queriendo añadir un adicional ya cuenta con uno",
}

➕ Registrarse como adicional ​

Esta es la segunda (y última) etapa de registro de adicional, donde el invitado completa un formulario con sus datos para concluir su registro.

🏬 Obtener Concesionarios ​

Listado de concesionarios que se le disponen al usuario al momento de registrarse.

  • URL: /api/auth/register/dealerships
  • Método: GET

Response ​

json
{
  "success": true,
  "data": [
        {
            "id": 1,
            "bir": 3200001,
            "nombre_concesionario": "Nombre 1",
            "nombre": "Nombre 2",
            "domicilio": "Av. Siempreviva 742",
            "codigo_postal": 1000,
            "localidad": "Springfield",
            "provincia": "Massachusetts",
            "tipo": "CONCESIONARIO",
            "primaria_secundaria": null,
            "activo": 1
        },
        {
            "id": 2,
            "bir": 3200002,
            "nombre_concesionario": "Nombre 1",
            "nombre": "Nombre 2",
            "domicilio": "Negra Arroyo Lane 308",
            "codigo_postal": 1102,
            "localidad": "Albuquerque",
            "provincia": "New Mexico",
            "tipo": "BOCA DE VENTA",
            "primaria_secundaria": null,
            "activo": 1
        },
    ]
}