Documentación API

Integra TransLedger con tu ERP, TMS o cualquier sistema externo mediante nuestra API REST

Introducción

La API REST de TransLedger te permite integrar la gestión de Cartas de Porte Electrónicas (eCMR) directamente con tu ERP, TMS o cualquier sistema externo. Automatiza la creación de eCMRs, consulta estados en tiempo real y recibe notificaciones mediante webhooks.

Base URL: https://transledger.es/api

¿Necesitas una API Key?

Las API Keys se generan desde tu panel de usuario una vez registrado en la plataforma.

Empezar Gratis

Autenticación

Todas las peticiones a la API deben incluir tu API Key en la cabecera HTTP:

X-API-Key: tu_clave_api_aqui

Endpoints

GET /api/ecmrs

Listar todos los eCMRs del usuario autenticado.

Parámetros de query:

page - Número de página (default: 1)
limit - Resultados por página (default: 20)
status - Filtrar por estado (borrador, asignado, en_transito, entregado, incidencia)
search - Búsqueda por texto

POST /api/ecmrs

Crear un nuevo eCMR.

Body (JSON):

{
  "sender_company_name": "Logística Martínez SL",
  "sender_address": "Calle Mayor 1, Madrid",
  "sender_city": "Madrid",
  "receiver_company_name": "Almacén Central SA",
  "receiver_address": "Av. Diagonal 100, Barcelona",
  "receiver_city": "Barcelona",
  "goods_description": "20 palés de productos electrónicos",
  "pickup_date": "2026-08-10"
}

GET /api/ecmrs/{id}

Obtener los detalles completos de un eCMR específico.

PUT /api/ecmrs/{id}

Actualizar un eCMR existente.

GET /api/tracking/{ecmr_number}

Tracking público de un envío (no requiere autenticación). Ideal para mostrar el estado en tu web o app al cliente final.

POST /api/webhooks

Registrar un webhook para recibir notificaciones en tiempo real cuando ocurren eventos en tus eCMRs (creación, firma, entrega, incidencia).

Body (JSON):

{
  "url": "https://tu-erp.com/webhook/transledger",
  "events": ["ecmr.created", "ecmr.signed", "ecmr.delivered"]
}

POST /api/ocr

Procesa una imagen de un CMR en papel y extrae los datos automáticamente mediante IA. La imagen debe enviarse en base64.

Body (JSON):

{
  "image": "data:image/jpeg;base64,...",
  "prompt": "Extrae remitente, destinatario y descripción de mercancía"
}

GET /api/health

Comprueba el estado de la API. No requiere autenticación.

Eventos de Webhook

ecmr.created

Se crea un nuevo eCMR

ecmr.signed

Un eCMR es firmado (cargador, transportista o destinatario)

ecmr.delivered

El eCMR se marca como entregado

ecmr.incidencia

Se reporta una incidencia en el envío

Asistentes de IA (MCP)

Además de la API REST, puedes conectar tu cuenta a Claude, ChatGPT o Cursor con el protocolo MCP. La autenticación es OAuth 2.1 con PKCE y el acceso es de solo lectura, limitado a la empresa que autoriza la conexión.

POST /mcp

Endpoint MCP (JSON-RPC 2.0). Requiere Authorization: Bearer.

/.well-known/oauth-protected-resource

Metadatos del recurso protegido. Público, sin autenticación.

/.well-known/oauth-authorization-server

Metadatos del servidor de autorización. Público, sin autenticación.

/oauth/register · /oauth/token · /oauth/revoke

Registro dinámico de clientes, canje del código (PKCE S256) y revocación de tokens.

Herramientas disponibles (todas de solo lectura): buscar_ecmrs, ver_ecmr, consultar_tracking, listar_webhooks, extraer_documento y estado_conexion.

Guía paso a paso: entra en tu cuenta y abre /conectar-ia (requiere plan Pro o Enterprise).

Códigos de respuesta

Código	Significado
`200`	OK - Petición exitosa
`201`	Created - Recurso creado
`400`	Bad Request - Datos inválidos
`401`	Unauthorized - API Key inválida
`404`	Not Found - Recurso no encontrado
`500`	Internal Server Error

¿Necesitas ayuda con la integración?

Nuestro equipo técnico te ayuda a integrar TransLedger con tu ERP o TMS en menos de 24h.

Contactar con soporte