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.

Get Started Free

Autenticación

All API requests must include your API Key in the HTTP header:

X-API-Key: tu_clave_api_aqui

Endpoints

GET /api/ecmrs

List all eCMRs for the authenticated user.

Query parameters:

page - Page number (default: 1)
limit - Results per page (default: 20)
status - Filter by status (draft, assigned, in_transit, delivered, incident)
search - Text search

POST /api/ecmrs

Create a new eCMR.

Body (JSON):

{
  "sender_company_name": "Martínez Logistics SL",
  "sender_address": "Calle Mayor 1, Madrid",
  "sender_city": "Madrid",
  "receiver_company_name": "Central Warehouse 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}

Get full details of a specific eCMR.

PUT /api/ecmrs/{id}

Update an existing eCMR.

GET /api/tracking/{ecmr_number}

Public shipment tracking (no authentication required). Ideal for showing status on your website or app.

POST /api/webhooks

Register a webhook to receive real-time notifications when events occur on your eCMRs (creation, signature, delivery, incident).

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

AI assistants (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.

Tools 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.

Contact support