Skip to main content
Todas las solicitudes de API responderán con un código de estado HTTP apropiado. Su cliente de API debería manejar cada clase de respuesta de manera diferente:
  • 2XX Respuestas exitosas
  • 4XX Las respuestas de error del cliente indican un problema con la solicitud, como parámetros faltantes o un valor no válido. Modifique la solicitud antes de volver a intentarlo.
  • 5XX Las respuestas de error del servidor indican un problema temporal en el lado de Alvys. Vuelva a intentar la solicitud después de un tiempo. Si los problemas persisten, comuníquese con el soporte para obtener más ayuda.

​
Códigos de error

Alvys utiliza códigos de respuesta HTTP convencionales para indicar el éxito o el fracaso de una solicitud de API. A continuación se muestra una tabla de códigos de error para ayudarle a depurar. El cuerpo de la respuesta de error puede incluir un mensaje de error, pero evite codificar mensajes específicos, ya que Alvys se reserva el derecho de cambiar el mensaje de error sin incrementar automáticamente la versión de API. Utilice mensajes de error únicamente con fines de depuración.

​
Sin resultados no es un error

Los puntos finales de lista y búsqueda devuelven 200 OK con una colección vacía cuando una consulta bien formada no coincide con ningún registro. Trate una matriz Items vacía (o una lista vacía) como un resultado vacío exitoso, no como una ruta faltante, un alcance de credencial faltante o un recurso faltante.
  • Búsqueda / lista paginada — La forma de la respuesta no cambia. Items es [], y los campos de paginación (Page, PageSize, Total) siguen reflejando la solicitud y el número de coincidencias de la consulta. No use 404 como señal de que “no hubo coincidencias”.
  • Listas de documentos — Cuando el recurso principal existe pero no tiene archivos adjuntos, el punto final devuelve 200 con []. 404 sigue significando que el id del recurso principal no existe o no es visible para su credencial.
Esto se aplica a transportistas, clientes, conductores, combustible, facturas, cargas, ubicaciones, mantenimiento, peajes, remolques, viajes, camiones, usuarios y errores de visibilidad saliente (incluidas las rutas de lista de documentos relacionadas).