La API de Chainlink es una API REST para integrar tu almacén con otros sistemas. Con ella administras el catálogo de productos, consultas inventario, clientes y proveedores, y automatizas operaciones como recepciones, pickings y conteos. Las rutas están orientadas a recursos, acepta cuerpos JSON y devuelve respuestas JSON, y se autentica con tokens Bearer.

La URL base es https://tu-empresa.chainlink.mx/api/v1. Empieza por Autenticación o ve directo al Quickstart.

Autenticación

Obtén un token, refréscalo y entiende su expiración.

Quickstart

De cero a crear tu primer producto vía API en minutos.

Referencia de la API

Todos los endpoints con parámetros y ejemplos por recurso.

Acceso y habilitación

Cómo se habilita la API y qué rutas autoriza BW Digital.

Conceptos clave

URL base y subdominio de tenant

Cada organización (tenant) vive en su propio subdominio. Todas las llamadas se hacen a tu subdominio, no a un dominio compartido:

URL base

https://tu-empresa.chainlink.mx/api/v1

Autenticación

La API usa tokens Bearer (OAuth2 / JWT). Inicias sesión con un usuario del tenant y adjuntas el token en cada petición:

Header de autorización

Authorization: Bearer TU_ACCESS_TOKEN

Formato de respuestas

Las respuestas son JSON. Los recursos de la API v1 usan el envoltorio estándar de Laravel (data, más links y meta cuando hay paginación). Los detalles están en Convenciones.

Habilitación por BW Digital

La API pública se activa por tenant y algunas rutas de escritura requieren autorización manual de BW Digital. Antes de integrar, revisa Acceso y habilitación para saber qué está disponible para tu organización y cómo solicitarlo.

¿Qué puedes construir?

Sincronizar tu catálogo: crea y actualiza productos y categorías desde tu ERP.
Consultar inventario en tiempo real: existencias por producto, almacén, lote y serie.
Automatizar operaciones: leer recepciones, pickings, transferencias y conteos.
Recibir eventos: suscribirte a webhooks para reaccionar a cambios.
Integrar impresión y RFID: enviar etiquetas a imprimir y consultar portales RFID.

Esta referencia documenta la API v1 (/api/v1), la versión pública y recomendada. Existen endpoints heredados bajo /api para integraciones antiguas de ERP; si los necesitas, contáctanos.