Version: 1.0.0
ECMR Addresses API
API REST completa para el sistema ECMR (Electronic Consignment Note) de Cargoffer, diseñada para la gestión integral de documentos de transporte electrónico.
Funcionalidades Principales
- Gestión de Direcciones: CRUD completo de direcciones con geocodificación automática - Autenticación y Usuarios: Sistema de autenticación JWT y API Keys, gestión de perfiles - Empresas y Transportistas: Administración de datos empresariales y perfiles de transportista - Conductores y Vehículos: Gestión de conductores activos y flota de vehículos - ECMRs Electrónicos: Creación, actualización y seguimiento de documentos de consignación - Firmas Digitales: Sistema de firmas electrónicas con soporte para imágenes - Códigos QR: Generación y validación de códigos QR para acceso móvil - Documentos Adjuntos: Gestión de archivos y documentos relacionados con ECMRs - Incidencias: Sistema de soporte y seguimiento de problemas - Facturación: Integración con sistemas de pago y facturación
Autenticación
Soporta autenticación mediante JWT Bearer tokens y claves API para diferentes tipos de acceso.
Características Técnicas
- API RESTful con respuestas JSON - Paginación en listados - Validación de datos y manejo de errores - Soporte para subida de archivos (firmas, documentos) - Integración con servicios externos (Stripe para pagos, AWS S3 para almacenamiento)
Authentication
- HTTP: Bearer Auth
- API Key: apiKeyAuth
JWT Bearer authentication
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
API Key authentication for programmatic access.
- Company API keys start with 'C' (e.g., C123456789)
- Trucker API keys start with 'T' (e.g., T123456789)
Security Scheme Type: | apiKey |
|---|---|
Query parameter name: | apikey |
Contact
License