Saltar al contenido principal

Conductores

Administra a las personas que operan los vehículos de tu flota — lista, crea y actualiza perfiles de conductores.

Requisitos previos

Todos los endpoints requieren un token JWT válido, una clave de API y el encabezado tenant. Consultá Autenticación.


Listar conductores​

Obtiene una lista paginada de conductores con soporte de filtrado.

GET/apidev/v1/fleet/drivers
PermisoAPICLI_FLEET_DRIVERS_READ
Límite de solicitudes30 solicitudes/min (ventana deslizante)
Caché120s

Parámetros de consulta​

ParámetroTipoRequeridoPor defectoDescripción
limitintegerNo25Registros por página. Mín: 1, Máx: 100
offsetintegerNo0Registros a omitir
statusstringNo—A (activo) o I (inactivo)
namestringNo—Coincidencia parcial sobre el nombre o correo del conductor. Longitud máxima 80
documentstringNo—Coincidencia parcial sobre el número de documento. Longitud máxima 30
driver_groupstringNo—Coincidencia parcial sobre el nombre del grupo de conductores. Longitud máxima 80

Campos de la respuesta​

CampoTipoDescripción
idstringIdentificador único del conductor (BigInt como string)
namestring | nullNombre completo del conductor
documentstring | nullNúmero de documento de identidad
emailstring | nullDirección de correo electrónico
phonestring | nullNúmero de teléfono
image_urlstring | nullURL de la foto del conductor
external_codestring | nullCódigo de integración externa
activebooleanSi el conductor está activo actualmente
statusstring"A" (activo) o "I" (inactivo)
driver_groupstring | nullGrupo o categoría del conductor
assigned_vehicleobject | nullVehículo asignado (ver más abajo)

Objeto assigned_vehicle:

CampoTipoDescripción
idstringIdentificador del vehículo
namestring | nullNombre para mostrar del vehículo
license_platestring | nullPatente del vehículo

Ejemplo de código​

curl -s "https://$TENANT/apidev/v1/fleet/drivers?limit=10&status=A" \
-H "Authorization: Bearer $TOKEN" \
-H "X-API-Key: $APIKEY" \
-H "tenant: $TENANT"

Respuesta de ejemplo​

{
"success": true,
"data": [
{
"id": "104820579455",
"name": "Carlos Martinez",
"document": "12345678",
"email": "carlos@company.com",
"phone": "+59899654321",
"image_url": null,
"external_code": "DRV-042",
"active": true,
"status": "A",
"driver_group": "Long Haul",
"assigned_vehicle": {
"id": "104820579301",
"name": "Movil 10",
"license_plate": "ABC123"
}
},
{
"id": "104820579460",
"name": "Maria Lopez",
"document": "87654321",
"email": "maria@company.com",
"phone": "+59899123456",
"image_url": null,
"external_code": null,
"active": true,
"status": "A",
"driver_group": "Urban",
"assigned_vehicle": null
}
],
"meta": {
"total": 28,
"limit": 10,
"offset": 0
}
}

Crear conductor​

Crea un nuevo perfil de conductor. Solo name es requerido.

POST/apidev/v1/fleet/drivers
PermisoAPICLI_FLEET_DRIVERS_WRITE
Límite de solicitudes30 solicitudes/min (ventana deslizante)
CachéNinguna

Cuerpo de la solicitud​

CampoTipoRequeridoLongitud máximaDescripción
namestringSí200Nombre completo del conductor
documentstringNo100Número de documento de identidad
document_typenumberNo—Identificador del tipo de documento
emailstringNo200Dirección de correo electrónico
phonestringNo50Número de teléfono fijo
mobilestringNo50Número de teléfono móvil
statusstringNo10"A" o "I" (por defecto: "A")
driver_type_idstringNo40Identificador de la categoría del conductor
vehicle_idstringNo40Vehículo a asignar
supervisor_idstringNo40Conductor supervisor
external_codestringNo100Código de integración externa
ibuttonstringNo100Código de identificación iButton
pinstringNo20PIN del conductor
notesstringNo2000Notas de texto libre
image_urlstringNo500URL de la foto del conductor
streetstringNo200Dirección de la calle
street_numberstringNo20Número de la calle
apartmentstringNo20Apartamento o unidad
cornerstringNo200Esquina
country_idstringNo40Identificador del país
department_idstringNo40Identificador del departamento/estado
latitudestringNo40Latitud del domicilio
longitudestringNo40Longitud del domicilio
birth_datestringNo20Fecha de nacimiento (ISO 8601)
hire_datestringNo20Fecha de contratación (ISO 8601)
termination_datestringNo20Fecha de baja (ISO 8601)
legal_namestringNo200Razón social/nombre legal
tax_idstringNo50Número de identificación fiscal

Ejemplo de código​

curl -s -X POST "https://$TENANT/apidev/v1/fleet/drivers" \
-H "Authorization: Bearer $TOKEN" \
-H "X-API-Key: $APIKEY" \
-H "tenant: $TENANT" \
-H "Content-Type: application/json" \
-d '{
"name": "Carlos Martinez",
"document": "12345678",
"document_type": 1,
"email": "carlos@company.com",
"mobile": "+59899654321",
"vehicle_id": "104820579301"
}'

Respuesta de ejemplo — 201 Created​

{
"success": true,
"data": {
"id": "104820579499"
}
}

Actualizar conductor​

Actualiza un perfil de conductor. Enviá solo los campos que quieras cambiar. Enviá null para limpiar un campo que admita nulos.

PUT/apidev/v1/fleet/drivers/{id}
PermisoAPICLI_FLEET_DRIVERS_WRITE
Límite de solicitudes30 solicitudes/min (ventana deslizante)
CachéNinguna

Parámetros de ruta​

ParámetroTipoRequeridoDescripción
idstringSíIdentificador único del conductor

Cuerpo de la solicitud​

Se aceptan todos los campos de Crear conductor, pero ninguno es requerido. Consultá Actualizaciones parciales para el patrón general.

Ejemplo de código​

curl -s -X PUT "https://$TENANT/apidev/v1/fleet/drivers/104820579455" \
-H "Authorization: Bearer $TOKEN" \
-H "X-API-Key: $APIKEY" \
-H "tenant: $TENANT" \
-H "Content-Type: application/json" \
-d '{
"email": "new.email@company.com",
"phone": null,
"vehicle_id": "104820579315"
}'

Respuesta de ejemplo​

{
"success": true,
"data": {
"id": "104820579455",
"updated_fields": ["email", "phone", "vehicle_id"]
},
"meta": {}
}

Errores​

CódigoHTTPAplica aDescripción
VALIDATION_ERROR400Listar, Crear, ActualizarParámetros o cuerpo inválidos (p. ej., falta name al crear, limit > 100)
UNAUTHORIZED401Todostenant / Authorization / X-API-Key ausente, inválido o expirado
FORBIDDEN403TodosEl usuario no tiene APICLI_FLEET_DRIVERS_READ o APICLI_FLEET_DRIVERS_WRITE
NOT_FOUND404ActualizarEl ID del conductor no existe o no pertenece a tu tenant
RATE_LIMITED429TodosSe superaron 30 solicitudes/min