Documentación

Autenticación

Parámetros:

usercode Requerido
password Requerido
Status 200
    
{
  "login": true,
  "user": {
    "id": "usr_cBde",
    "area": "4"
  },
  "message": "Usuario autenticado"
}          
    
    
Status 400
Usercode y Password son requeridos:
    
{
  "login": false,
  "errors": {
    "usercode": "Ingresa tu Código de usuario",
    "password": "Ingresa tu Contraseña"
  },
  "message": "Usuario y contraseña son requeridos"
}        
    
    
Status 400
Usercode no válido:
    
{
  "login": false,
  "errors": {
    "usercode": "Código de usuario no existe",
    "password": ""
  }
}         
    
    
Status 400
Password incorrecto:
    
{
  "login": false,
  "errors": {
    "usercode": "",
    "password": "Ingresa tu Contraseña"
  },
  "message": "Usuario y contraseña son requeridos"
}        
    
    
Status 404
    
{
  "error": 404,
  "message": "URL Inválida"
}          
    
    
Obtener todas las armadoras
Status 200
    
{
"manufacturers": [
    {
    "manufacturer_id": "man_acura",
    "manufacturer_name": "Acura",    
    "manufacturer_logo": "https://cdn.colorcril.app/manufacturers/acura.png",
    },
    {...},
    {...},
]
}            
    
    
Status 404
    
{
  "manufacturers": null,
  "message": "No se encontraron resultados"
}           
    
    
Obtener una armadora y sus vehículos
Ejemplo: https://apiv2.colorcril.app/manufacturers/man_acura
Status 200
    
{
  "manufacturer": {
    "manufacturer_id": "man_acura",
    "manufacturer_name": "Acura",
    "vehicles": [
      {
        "vehicle_id": "ve-acura-ilx-2019",
        "vehicle_model": "ilx",
        "vehicle_name": "ILX",
        "vehicle_year": "2019",
        "vehicle_image": "https://cdn.colorcril.app/vehicles/acura_ilx_2019_2020_NH830M.png"
      },
      {...},
      {...},
    ]
  }
}           
    
    
Status 404
    
{
  "manufacturers": null,
  "message": "No se encontraron resultados"
}           
    
    
Búsqueda por armadora
Ejemplo: https://apiv2.colorcril.app/manufacturers/search?manufacturer=vbw
Status 200
    
  {
  "manufacturers": [
    {
      "manufacturer_id": "man_bmw",
      "manufacturer_name": "BMW",
      "manufacturer_logo": "https://cdn.colorcril.app/manufacturers/bmw.png",
    },
    {...},
    {...},
    {...},
  ]
}          
    
    
Status 404
    
{
  "manufacturers": null,
  "message": "No se encontraron resultados"
}           
    
    
Obtener todos los vehículos (por página)
Status 200
    
  {
  "vehicles": [
    {
      "vehicle_id": "ve-acura-ilx-2019",
      "vehicle_model": "ilx",
      "vehicle_name": "ILX",
      "vehicle_year": "2019",
      "vehicle_image": "https://cdn.colorcril.app/vehicles/acura_ilx_2019_2020_NH830M.png"
    },
    {...},
    {...},
    {...},
  ],
  "total_elements": 2145,
  "per_page": 50,
  "total_pages": 43,
  "current_page": "1",
  "links": {
    "next": "https://apiv2.colorcril.app/vehicles?page=2",
    "prev": null,
    "pages": [
      {
        "number": 1,
        "url": "https://apiv2.colorcril.app/vehicles?page=1"
      },
      {
        "number": 2,
        "url": "https://apiv2.colorcril.app/vehicles?page=2"
      },
      {...},
      {...},
      {...},
    ]
  }
}         
    
    
Status 404
    
{
  "vehicles": null,
  "message": "No se encontraron resultados"
}           
    
    
Obtener todos los vehículos (por modelo)
Status 200
    
{
  "vehicles": [
    {
      "vehicle_id": "ve-ford-figo-2019",
      "vehicle_name": "Figo",
      "vehicle_year": "2019",
      "vehicle_image": "https://cdn.colorcril.app/vehicles/ford_figo_2019_2020_B9.png"
    },
    {...},
    {...}
  ]
}         
    
    
Status 404
    
{
  "vehicles": null,
  "message": "No se encontraron resultados"
}           
    
    
Obtener un vehículo (por su ID)
Status 200
    
  {
  "vehicle": {
    "vehicle_id": "ve-acura-ilx-2019",
    "vehicle_name": "ILX",
    "vehicle_year": "2019",
    "vehicle_image": "https://cdn.colorcril.app/vehicles/acura_ilx_2019_2020_NH830M.png",
    "vehicle_colors": [
      {
        "color_id": "NH830M",
        "color_name": "Plata Lunar",
        "color_hex": "#909396"
      },
      {...},
      {...},
    ],
    "manufacturer_info": {
      "manufacturer_id": "man_acura",
      "manufacturer_name": "Acura",
      "manufacturer_color_chip_location_image": "https://cdn.colorcril.app/manufacturers/color_chips/acura.jpg"
    }
  },
  "message": ""
}        
    
    
Status 404
    
{
  "vehicle": null,
  "message": "No se encontro el vehículo"
}           
    
    
Buscador de vehículo
Status 200
    
{
  "vehicles": [
    {
      "vehicle_id": "ve-acura-ilx-2019",
      "vehicle_name": "ILX",
      "vehicle_year": "2019",
      "vehicle_image": "https://cdn.colorcril.app/vehicles/acura_ilx_2019_2020_NH830M.png"
    },
    {...},
    {...},
  ],
  "message": "Se encontraron 49 resultados"
}           
    
    
Status 404
    
{
  "vehicles": null,
  "message": "No se encontraron resultados"
}           
    
    
Obtener grupo de colores
Status 200
    
{
  "color_groups": [
    {
      "color_group_id": "colorg_amarillos",
      "color_group_name": "Amarillos",
      "color_group_hex": "#F4D03F",
      "colors": [
        {
          "color_id": "914",
          "color_name": "Amarillo Sol",
          "color_hex": "#D3A21F",
          "color_manufacturer": "MERCEDES BENZ"
        },
        {...},
        {... },
      ]
    },
    {
      "color_group_id": "colorg_azules",
      "color_group_name": "Azules",
      "color_group_hex": "#3498DB",
      "colors": [
        {
          "color_id": "162",
          "color_name": "South Seas Blue",
          "color_hex": "#3B80B7",
          "color_manufacturer": "MERCEDES BENZ"
        },
        {...},
        {...},
      ]
    },
  ],
  "message": ""
}           
    
    
Status 404
    
{
  "color_groups": null,
  "message": "No se encontraron resultados"
}           
    
    
Obtiene las fases y sus respectivos productos con los que se compone un color

Parámetros URL:

color_id Requerido

POST:

user_id Requerido
Status 200
    
{
  "phases": [
    {
      "name": "1ra. Capa-Base",
      "products": [
        {
          "product_id": "2400",
          "product_name": "BASE COLOR ACRILICO BLANCO ACABADO",
          "selected_quantity": 100,
          "unit": "mililitros",
          "unit_quantity": "0.39",
          "quantity": "39.32",
          "price_ml": "0.23",
          "total_price": "8.93"
        },
        {...},
      ]
    },
    {
      "name": "2da. Capa-Base",
      "products": [
        {
          "product_id": "2402",
          "product_name": "BASE COLOR VEHICULO DE AJUSTE",
          "selected_quantity": 100,
          "unit": "mililitros",
          "unit_quantity": "0.56",
          "quantity": "56.18",
          "price_ml": "0.24",
          "total_price": "13.54"
        },
        {...}
      ]
    }
  ],
  "message": "Este color tiene 2 fases",
}         
    
    
Status 404
El color solicitado no fue encontrado
    
{
  "phases": null,
  "message": "El color requerido no fue encontrado o no tiene fórmula definida",
}    
    
    
Status 403
El id de usuario no existe o no está autorizado para acceder a esta información:
    
{
  "message": "Usuario no autorizado"
}        
    
    
Status 404
    
{
  "error": 404,
  "message": "URL Inválida"
}          
    
    
Buscador por código de color

Parámetro URL:

color Requerido
Status 200
    
{
  "results": [
    {
      "color_id": "162",
      "color_name": "South Seas Blue",
      "color_hex": "#3B80B7"
    },
    {
      "color_id": "416",
      "color_name": "Carbón Black",
      "color_hex": "#1A1412"
    },
    {
      "color_id": "166B",
      "color_name": "Smooth Mint",
      "color_hex": "#83BE9E"
    },
    {...},
    {...},
    {...},
    {...}
  ],
  "message": "Se encontraron 7 colores"
}         
    
    
Status 404
No se encontraron coincidencias:
    
{
  "results": null,
  "message": "No existe un color con el código ingresado"
}       
    
    
Status 404
No se recibió el término de búsqueda:
    
{
  "results": null,
  "message": "Ingresa el código de color que deseas buscar"
}       
    
    
Generar PDF

Parámetros:

user_id Requerido
color_id Requerido
vehicle_id Requerido en vehículos)
quantity: La cantidad seleccionada por el usuario (num) Requerido
unit: Únicas opciones aceptadas -> "mililitros" |  "litros" Requerido
Status 200

En la respuesta exitosa obtenemos la url del pdf generado
    
{
  "url": "https://colorcril.app/cotizacion/cJF5bE6KCX",
}         
    
    
Status 400
No se recibieron los datos requeridos:
    
{
  "url": null,
  "message": "No se recibieron datos completos para generar su pdf"
}       
    
    
Status 404
El user_id no fue encontrado
    
{
  "url": null,
  "message": "No pudimos identificar a este usuario"
}         
    
    
Status 404
    
{
  "error": 404,
  "message": "URL Inválida"
}