Saltar al contenido principal
Version: 1.0.0

Address Module API

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

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

API for managing transport auctions

API for company user authentication, registration and account management

Proporciona endpoints para buscar y gestionar subastas de carga.

Módulo de facturación de Cargoffer para empresas transportistas. Permite gestionar y consultar toda la información relacionada con:

  • Facturación mensual y acumulada
  • Tarifas aplicadas
  • Consumos por usuarios, vehículos y transportistas
  • Generación de eCMRs

Características principales:

  • Consulta en tiempo real de la facturación actual
  • Histórico completo con desglose detallado
  • Integración con el sistema de autenticación JWT
  • Soporte para múltiples periodos de facturación

Ejemplos de uso:

  • Dashboard de facturación en aplicación web
  • Generación de informes mensuales
  • Conciliación con sistemas contables
  • Análisis de costes operativos

API for HS Code classification system (sections, chapters, headings, subheadings)

API for managing CMR (Consignment Note) documents

Proporciona endpoints para:

  • Crear tickets de contacto/soporte con diferentes categorías

Casos de uso típicos:

  • Reportar problemas técnicos
  • Solicitar información sobre funcionalidades
  • Reportar incidencias en entregas
  • Consultas generales sobre el servicio

Requiere autenticación JWT para empresas registradas o puede usarse de forma anónima.

This API provides endpoints for managing transportation contracts between companies and carriers. Includes functionality for:

  • Retrieving contract lists - Generating PDF contracts - Sending contracts via email All endpoints require authentication via JWT token.

Proporciona endpoints para: - Obtener información de países (público y admin) - Obtener regex para validación de códigos de país - Crear, actualizar y eliminar países (solo admin) Nota: - Los endpoints que modifican datos requieren autenticación como administrador

API for company dashboard statistics

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 for managing company invoices and payments

API for managing transport issues and support tickets

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

API for managing company carriers and their drivers

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 for managing company users

API for managing company vehicle fleet

Authentication​

JWT Bearer authentication

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT

License