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.

URL base
https://empresa.chainlink.mx/api/v1
Solicitud autenticada
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áginaContenido
RecursoPropósito, tabla de operaciones con su alcance y los objetos que devuelve con todos sus campos.
OperaciónMé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

TemaRegla
Paginaciónpage y per_page (máximo 100); respuesta {data, links, meta}.
Filtros y ordenFiltros por recurso, sort con - para orden descendente y updated_since.
IdempotenciaIdempotency-Key en las escrituras; obligatoria en documentos de entrada y salida.
ErroresSobre {error, errors, message} con error.code estable y request_id.
Límites de usoSolicitudes por minuto según el plan; 429 con Retry-After.
VersionesVersión en la URL; dentro de v1 solo se publican cambios compatibles.

Recursos y operaciones

Catálogo e inventario

Documentos y operación

Socios de negocio

Webhooks

Los eventos que Chainlink envía a otros sistemas están en Webhooks › Catálogo de eventos.