Saltar al contenido principal
Version: 1.0.0

Truckers Address API

Proporciona endpoints para gestionar direcciones y ubicaciones geográficas.

Proporciona endpoints para gestionar subastas, pujas y operaciones relacionadas.

Proporciona endpoints para:

  • Login y registro de transportistas
  • Gestión de cuentas
  • Recuperación de contraseñas

Proporciona endpoints para consultar la clasificación de mercancías.

Proporciona endpoints para gestionar la información de compañías de transportistas.

Descripción General​

Este API forma parte de la plataforma Cargoffer y proporciona servicios completos para la gestión de operaciones de transporte.

Funcionalidades Principales​

  • Dashboard de control para transportistas
  • Gestión de cargas y entregas
  • Sistema de subastas de transporte
  • Seguimiento en tiempo real de envíos
  • Documentación CMR digital

Requisitos​

  • Autenticación mediante JWT (Bearer token)
  • Cuenta verificada de transportista en Cargoffer
  • Licencias de transporte vigentes

Convenciones​

  • Todas las fechas/horas en formato ISO 8601 (UTC)
  • Códigos de carga con formato CARGO-AAAA-NNNNNN
  • Estados de entrega normalizados (EN_TRANSITO, ENTREGADO, PENDIENTE)

Documentación Relacionada​

Para soporte técnico contactar: soporte@cargoffer.com

Proporciona información sobre países disponibles para transportistas.

Este API forma parte de la plataforma Cargoffer y gestiona el dashboard principal para transportistas. Proporciona acceso a:

  • Resumen de cargas disponibles y asignadas
  • Estado de entregas en tiempo real
  • Notificaciones de subastas y adjudicaciones
  • Estadísticas de rendimiento y ganancias
  • Alertas de tráfico y condiciones meteorológicas

Requiere autenticación mediante JWT y solo está disponible para transportistas registrados en Cargoffer.

Proporciona endpoints para gestionar y consultar entregas.

Proporciona endpoints para gestionar registros de la Dirección General de Tráfico.

Descripción General​

Este API forma parte de la plataforma Cargoffer y proporciona gestión completa de la flota de conductores para empresas de transporte.

Funcionalidades Principales​

  • Registro y gestión de perfiles de conductores
  • Control de estados y disponibilidad
  • Asignación de vehículos y rutas
  • Seguimiento de horas de conducción (tacógrafo digital)
  • Gestión de documentación y licencias
  • Integración con sistemas de geolocalización

Alcance y Limitaciones​

  • Acceso restringido a transportistas autenticados
  • Operaciones sensibles requieren rol de administrador de flota
  • Límite de 100 peticiones por minuto por empresa
  • Cumplimiento de normativas de tiempos de conducción EU

Versión Actual​

Esta es la versión 1.0.0 del API, compatible con todas las versiones de Transcend a partir de 2024.1.

Proporciona endpoints para consultar y gestionar las tarifas aplicables a los transportistas en la plataforma.

Funcionalidades principales:​

  • Consulta del porcentaje de tarifa actual
  • La tarifa se aplica sobre el valor de los envíos/transacciones
  • Valor por defecto: 6% (configurable en settings)

Casos de uso:​

  • Calcular comisiones para transportistas
  • Mostrar tarifas actuales en el panel de control
  • Integración con sistemas de facturación

Este API es parte del sistema Transcend y corresponde al módulo de gestión de archivos para transportistas.

Propósito: Proporciona un interfaz seguro para acceder y gestionar archivos genéricos almacenados en Amazon S3.

Características principales:

  • Recuperación segura de archivos mediante autenticación JWT
  • Soporte para múltiples formatos (PDF, imágenes, binarios)
  • Integración directa con Amazon S3

Tipos de archivos comunes:

  • Documentos legales (contratos, facturas)
  • Imágenes de perfil y documentos escaneados
  • Archivos binarios específicos de la aplicación

Audiencia: Transportistas registrados en la plataforma Cargoffer.

Permite crear y gestionar grupos de compañías de transportistas.

Este módulo proporciona acceso al Sistema Armonizado (HS) de clasificación de mercancías, adaptado específicamente para el sector de transporte y logística.

Funcionalidades clave:

  • Navegación jerárquica completa del sistema HS (secciones, capítulos, headings, subheadings)
  • Búsqueda textual de códigos HS y sus descripciones
  • Integración con sistemas de cálculo de aranceles y regulaciones de comercio

Casos de uso típicos:

  1. Clasificación de mercancías para documentación de transporte
  2. Cálculo preliminar de aranceles e impuestos
  3. Validación de códigos HS en procesos aduaneros
  4. Integración con sistemas TMS (Transport Management Systems)

Ejemplo de flujo:

  1. Buscar código HS por término ("caballos")
  2. Obtener detalles completos del código seleccionado
  3. Consultar regulaciones asociadas al código

Módulo especializado para gestión de imágenes en la plataforma Transcend.

Funcionalidades principales:

  • Acceso seguro a imágenes almacenadas en Amazon S3
  • Soporte para formatos JPEG, PNG, GIF y WEBP
  • Autenticación mediante JWT

Almacenamiento: Las imágenes pueden incluir:

  • Fotografías de perfil de transportistas
  • Documentación escaneada (licencias, permisos)
  • Imágenes de vehículos y mercancías

Módulo especializado para la gestión integral de facturas de transportistas en la plataforma CargOffer.

Funcionalidades principales:

  • Creación y gestión de facturas (draft, issued, paid, cancelled)
  • Consulta de facturas con paginación avanzada
  • Integración con sistema de autenticación JWT
  • Gestión de direcciones asociadas (países, estados, ciudades)

Ejemplos de uso:

  • Facturación de servicios de transporte
  • Gestión de pagos a transportistas
  • Consulta de historial de facturas

Requisitos:

  • Autenticación mediante JWT válido
  • Permisos de transportista activos

Proporciona acceso a estaciones de servicio y parkings.

Requiere autenticación para algunos endpoints y aplica rate limiting.

Proporciona endpoints para obtener costos y datos minimales para transportistas.

Gestiona integración con Stripe, métodos de pago y procesamiento de transacciones.

Permite gestionar la configuración general del sistema.

Proporciona endpoints para gestionar tickets de soporte y problemas.

Proporciona endpoints para gestionar usuarios transportistas en el sistema.

Permite gestionar los vehículos asociados a compañías de transportistas.

Authentication​

JWT Bearer authentication

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT

License