Endpoints de la API v1
Especificación exacta de cada operación de la API v1: parámetros, cuerpo, respuestas, alcances y ejemplos. Se genera del documento OpenAPI 3.1 con el que las pruebas de Chainlink validan cada respuesta real.
En esta página
Las Guías describen procedimientos completos, por ejemplo la sincronización del catálogo o el envío de documentos desde un ERP. Esta sección es la consulta exhaustiva: una página por recurso y una página por operación, con la descripción de cada campo a la izquierda y la solicitud y las respuestas de ejemplo a la derecha.
Cada empresa tiene su propia instancia y su propia API; todas las rutas son relativas a la URL base de la instancia (con dominio propio, la URL base usa ese dominio). Cada solicitud lleva Authorization: Bearer <token>: las integraciones usan un cliente de integración (client_credentials) con los alcances que indica cada operación. El procedimiento completo y las reglas de los tokens de usuario están en Autenticación.
https://empresa.chainlink.mx/api/v1
curl "https://empresa.chainlink.mx/api/v1/products?per_page=10" \
-H "Authorization: Bearer $CHAINLINK_TOKEN" \
-H "Accept: application/json"
Estructura de esta sección
| Página | Contenido |
|---|---|
| Recurso | Propósito, tabla de operaciones con su alcance y los objetos que devuelve con todos sus campos. |
| Operación | Método y ruta, alcance o permiso requerido, parámetros, cuerpo, respuestas por código de estado, ejemplos en cURL, PHP, JavaScript y Python, y la consola «Probar». |
Los ejemplos de solicitud y de respuesta se ejecutan contra la API real en las pruebas de Chainlink: cada ejemplo de respuesta tiene exactamente los campos que la API devuelve.
Convenciones comunes
| Tema | Regla |
|---|---|
| Paginación | page y per_page (máximo 100); respuesta {data, links, meta}. |
| Filtros y orden | Filtros por recurso, sort con - para orden descendente y updated_since. |
| Idempotencia | Idempotency-Key en las escrituras; obligatoria en documentos de entrada y salida. |
| Errores | Sobre {error, errors, message} con error.code estable y request_id. |
| Límites de uso | Solicitudes por minuto según el plan; 429 con Retry-After. |
| Versiones | Versión en la URL; dentro de v1 solo se publican cambios compatibles. |
Recursos y operaciones
Catálogo e inventario
Catálogo de productos y sus categorías. El código (`item_code`) identifica al producto en documentos y existencias.
- GET
Listar productos
/products - POST
Crear un producto
/products - GET
Consultar un producto
/products/{id} - PUT
Actualizar un producto (PUT)
/products/{id} - PATCH
Actualizar un producto
/products/{id} - DEL
Eliminar un producto
/products/{id} - GET
Listar categorías
/product-categories - GET
Consultar una categoría
/product-categories/{id}
Existencias por ubicación, lote y serie, y niveles por producto (a la mano y disponible).
Documentos y operación
Lo que el ERP manda a recibir (órdenes de compra, entradas) o a surtir (pedidos, remisiones). Cada documento
- GET
Listar documentos de entrada
/entry-documents - POST
Crear un documento de entrada
/entry-documents - GET
Consultar un documento de entrada
/entry-documents/{id} - GET
Listar documentos de salida
/exit-documents - POST
Crear un documento de salida
/exit-documents - GET
Consultar un documento de salida
/exit-documents/{id}
El trabajo que el almacén hizo sobre los documentos, con su operador, sus tiempos y sus líneas.
Traslados de mercancía entre almacenes, de la creación a la recepción en destino.
Grupos de pedidos que se surten juntos. Requiere el módulo de olas.
Archivos de Excel o CSV con productos o documentos, validados antes de aplicarse.
Socios de negocio
Los socios de negocio de las salidas (clientes) y de las entradas (proveedores).
- GET
Listar clientes
/clients - POST
Crear un cliente
/clients - GET
Consultar un cliente
/clients/{id} - PUT
Actualizar un cliente (PUT)
/clients/{id} - PATCH
Actualizar un cliente
/clients/{id} - DEL
Eliminar un cliente
/clients/{id} - GET
Listar proveedores
/providers - POST
Crear un proveedor
/providers - GET
Consultar un proveedor
/providers/{id} - PUT
Actualizar un proveedor (PUT)
/providers/{id} - PATCH
Actualizar un proveedor
/providers/{id} - DEL
Eliminar un proveedor
/providers/{id}
Webhooks
Avisos HTTP firmados cuando algo cambia en el almacén. Requiere el plan Professional o Enterprise.
Los eventos que Chainlink envía a otros sistemas están en Webhooks › Catálogo de eventos.