Empezá

Introducción a la API

Cómo está armada la API del ERP y por dónde empezar.

La API del ERP es la misma que usa la pantalla. Cada botón que tocás en el ERP llama a una de estas operaciones, con las mismas reglas y los mismos permisos. Una integración no tiene atajos: lo que una persona no puede hacer, su integración tampoco.

Cómo es una operación

Cada operación tiene una ruta /api/v1/<módulo>/<acción>:

Las lecturas usan GET y reciben sus filtros en la consulta: GET /api/v1/items/list?search=tornillo.
Las escrituras usan POST con un cuerpo JSON y una Idempotency-Key: POST /api/v1/sales-orders/create.
Las descargas (PDF, Excel, adjuntos) usan POST y responden el archivo.

Todas responden JSON, salvo las descargas, y todos los rechazos usan el mismo formato de errores.

La dirección

Cada cliente tiene su propia instalación del ERP, con su propia dirección. La API está en esa misma dirección, debajo de /api/v1. En los ejemplos usamos la variable $ERP_URL:

export ERP_URL="https://erp.tuempresa.com.ar"

Empresas

Una instalación tiene una o varias empresas legales que nunca comparten datos. Casi todas las operaciones trabajan sobre una empresa y piden el encabezado X-Expected-Company. Ver Empresa activa.

Por dónde seguir

AutenticaciónCómo se identifica la integración.

ErroresEl formato de los rechazos y sus códigos.

IdempotenciaReintentar sin duplicar un pedido o un pago.

ReferenciaTodas las operaciones, agrupadas como el menú.