Saltar al contenido principal
Version: 1.0.0

Company Module API

Nota: Los IDs y ejemplos mostrados son de prueba. Por favor, sustitúyalos por datos reales.

API para gestión de direcciones de compañía

API para gestión de claves API de la compañía

API para la gestión de subastas de transporte

API para autenticación, registro y gestión de cuentas de usuarios de la compañía

Proporciona endpoints para buscar y gestionar subastas de carga.

Módulo de facturación de Cargoffer para empresas de transporte.

Sistema integral de gestión financiera que permite controlar toda la información relacionada con:

  • Facturación de servicios de transporte
  • Costes operativos por ruta y vehículo
  • Comisiones de la plataforma Cargoffer
  • Liquidaciones con transportistas colaboradores
  • Generación automática de documentos CMR

Características principales:

  • Dashboard financiero en tiempo real
  • Histórico completo con análisis de rentabilidad
  • Integración con sistemas contables externos
  • Informes personalizables por periodo
  • Alertas de límites de crédito y pagos pendientes

Casos de uso empresariales:

  • Control de márgenes por cliente y ruta
  • Análisis de costes vs transporte propio
  • Reporting financiero para dirección
  • Conciliación automática de gastos
  • Optimización de rentabilidad operativa

API para el sistema de clasificación de códigos HS (secciones, capítulos, partidas, subpartidas)

API para la gestión de documentos CMR (Carta de Porte)

Sistema de Soporte Cargoffer - Atención especializada en transporte

Proporciona endpoints para gestionar comunicación directa con el equipo de soporte:

Categorías de soporte disponibles:

  • Problemas técnicos de la plataforma
  • Incidencias en entregas y transportistas
  • Consultas sobre facturación y pagos
  • Solicitudes de nuevas funcionalidades
  • Asistencia en procesos de integración

Tipos de usuarios atendidos:

  • Empresas cargadoras registradas (con autenticación JWT)
  • Transportistas de la red Cargoffer
  • Usuarios no registrados (consultas generales)
  • Partners tecnológicos y integradores

Funcionalidades del sistema:

  • Tickets categorizados por prioridad
  • Seguimiento de estado en tiempo real
  • Histórico de consultas anteriores
  • Escalado automático según criticidad
  • Integración con CRM empresarial

Esta API proporciona endpoints para gestionar contratos de transporte entre empresas y transportistas. Incluye funcionalidad para:

  • Recuperar listas de contratos - Generar contratos en PDF - Enviar contratos por correo electrónico Todos los endpoints requieren autenticación mediante token JWT.

API para estadísticas del panel de control de la empresa

API para gestionar datos y firmas del perfil de la empresa

API para la gestión de entregas de transporte

API para gestión de documentos de empresas. Permite subir, listar, actualizar y eliminar documentos asociados a una compañía, con control de versiones y estados.

API para la gestión de facturas y pagos de la empresa

API para la gestión de incidencias de transporte y tickets de soporte

API para cálculos mínimos de rutas (costos, CO2, información de ruta)

API para la gestión de transportistas de la empresa y sus conductores

API para la gestión integral de notificaciones dentro de la plataforma CargOffer.

Proporciona endpoints para:

  • Consultar notificaciones del dashboard
  • Marcar notificaciones como leídas
  • Eliminar notificaciones

Audiencia:

  • Aplicaciones cliente de CargOffer
  • Integraciones empresariales

Seguridad:

  • Autenticación mediante JWT
  • Acceso restringido a usuarios autorizados

API para gestión de pagos y métodos de pago de compañía

Este módulo permite gestionar el ciclo completo de entregas mediante tokens QR:

  • Consulta de información de entregas
  • Confirmación de entregas
  • Reporte de incidencias

Funcionalidades clave:

  • Autenticación mediante JWT (Bearer token)
  • Tokens QR únicos por entrega
  • Integración con el sistema de tracking
  • Notificaciones en tiempo real

Requisitos:

  • Acceso autorizado con token JWT válido
  • Permisos adecuados para operaciones QR
  • Tokens generados por el sistema

Consideraciones:

  • Los tokens QR tienen validez limitada
  • Las confirmaciones son irreversibles
  • Las incidencias generan notificaciones automáticas

Ejemplo de flujo completo:

  1. Escanear QR → GET /{token}
  2. Verificar datos de entrega
  3. Confirmar entrega → PUT /confirm
  4. (Opcional) Reportar incidencia → POST /issue

API para gestión de configuraciones de la plataforma

Proporciona endpoints para buscar estaciones por:

  • Mejor valoración
  • Precio más económico
  • Proximidad geográfica
  • Provincia
  • Ruta específica

API para la gestión de usuarios de la empresa

API para la gestión de la flota de vehículos de la empresa

API para gestión integral de transportistas asociados a la empresa

Sistema de Gestión de Transportistas Colaboradores

Proporciona endpoints para administrar transportistas que trabajan con la compañía:

Funcionalidades principales:

  • Registro individual y masivo (CSV) de transportistas
  • Gestión completa del perfil de conductores
  • Asignación de vehículos por defecto
  • Control de acceso y permisos
  • Filtrado por DNI/NIE/CIF
  • Obtención de información de contacto

Casos de uso empresariales:

  • Onboarding de nuevos transportistas
  • Actualización de datos de conductores
  • Importación masiva desde sistemas externos
  • Consulta rápida por identificación fiscal
  • Gestión de flota colaborativa

Características avanzadas:

  • Envío automático de credenciales por email
  • Validación de datos fiscales (taxid)
  • Verificación de correos electrónicos
  • Plantillas CSV para importación
  • Notas de ayuda multiidioma

Seguridad:

  • Autenticación JWT obligatoria
  • Verificación de pertenencia a compañía
  • Control de permisos multitenant
  • Límites según plan de suscripción

Authentication​

JWT Bearer authentication

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT

License