API para desarrolladores

Construye sobre Ventyx — API REST completa

Integra inventario, ventas y finanzas en tus propias aplicaciones con nuestra API REST documentada

Autenticación

Ventyx usa OAuth 2.0 con flujo de credenciales de cliente. Obtén un token de acceso que expira cada hora. Todos los endpoints requieren el header Authorization: Bearer {token}.

Tokens firmados con RSA-256
Expiración configurable (1h por defecto)
Scopes por módulo: read, write, admin
Revocación instantánea desde el panel

POST /api/v1/oauth/token
Content-Type: application/json

{
  "client_id": "your_client_id",
  "client_secret": "your_secret",
  "grant_type": "client_credentials"
}

// Response
{
  "access_token": "eyJhbGciOiJSUzI1NiJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Endpoints principales

Rutas organizadas por dominio funcional — usa los headers de autenticación en cada llamada

Inventario

/api/v1/inventory

GET/api/v1/inventory/productsListar todos los productos del catálogo

POST/api/v1/inventory/productsCrear un nuevo producto

GET/api/v1/inventory/stock/{sku}Consultar stock disponible por SKU

POST/api/v1/inventory/movementsRegistrar entrada o salida de inventario

Ventas

/api/v1/sales

GET/api/v1/sales/ordersListar órdenes de venta con filtros

POST/api/v1/sales/ordersCrear una nueva orden de venta

GET/api/v1/sales/orders/{id}Obtener detalle de una orden

PATCH/api/v1/sales/orders/{id}/statusActualizar estado de la orden

CRM

/api/v1/crm

GET/api/v1/crm/customersListar clientes con segmentación

POST/api/v1/crm/customersCrear o importar un cliente

GET/api/v1/crm/pipeline/opportunitiesObtener oportunidades del pipeline

Facturación

/api/v1/billing

POST/api/v1/billing/invoicesEmitir una factura electrónica (DIAN)

GET/api/v1/billing/invoices/{id}Consultar estado de una factura

POST/api/v1/billing/credit-notesGenerar nota crédito sobre factura existente

Tesorería

/api/v1/treasury

GET/api/v1/treasury/bank-accountsListar cuentas bancarias vinculadas

GET/api/v1/treasury/cashflowObtener proyección de flujo de caja

POST/api/v1/treasury/paymentsRegistrar un pago o transferencia

Webhooks

Recibe notificaciones en tiempo real en tu endpoint HTTP

inventory.low_stock

{
  "sku": "PROD-001",
  "current_stock": 3,
  "min_stock": 10,
  "warehouse_id": "wh_bogota"
}

order.created

{
  "order_id": "ord_8f2k9",
  "customer_id": "cus_1234",
  "total": 450000,
  "currency": "COP"
}

order.paid

{
  "order_id": "ord_8f2k9",
  "paid_at": "2026-03-28T14:30:00Z",
  "amount": 450000
}

invoice.issued

{
  "invoice_id": "FE-0001234",
  "cufe": "abc123...",
  "status": "accepted"
}

payment.received

{
  "payment_id": "pay_xyz99",
  "amount": 2500000,
  "account_id": "acc_001"
}

Rate limits por plan

Plan	Acceso API	Límite diario
ESENCIAL	No disponible	—
PROFESIONAL	No disponible	—
AVANZADO	Incluido	2.000 req/día
ENTERPRISE	Incluido	Ilimitado

SDKs y herramientas

Acelera tu integración con nuestras librerías oficiales

Beta

Node.js / TypeScript SDK

Cliente tipado para Node y Deno con soporte nativo de async/await.

Próximamente

Python SDK

Librería oficial para Python 3.10+ con soporte para Django y FastAPI.

Disponible

Postman Collection

Colección completa importable con variables de entorno configuradas.

Disponible

OpenAPI 3.0 Spec

Especificación YAML para generar clientes en cualquier lenguaje.

Sandbox de pruebas

Dispones de un entorno sandbox completamente separado de producción. Genera tus API keys de prueba desde el panel y experimenta con datos ficticios sin riesgo. Incluye la Postman Collection preconfigurada para comenzar en minutos.

Accede a la documentación técnica completa

Referencia detallada de todos los endpoints, esquemas de datos y guías de integración con ejemplos reales.