Empieza aquí
El REST API de ClickBalance ERP te permite leer y escribir datos del ERP desde cualquier cliente HTTP — sin acoplarte al frontend monolítico, sin SOAP, sin ODBC. Solo Bearer tokens y JSON.
Esta guía te lleva desde cero hasta tu primer request real, en menos de 5 minutos contra una instancia local del ERP.
1. Obtener un Bearer token
El primer paso siempre es autenticarte contra POST /api/v1/auth/login.
El usuario y password son los de ws_usuario_empresa (la tabla de usuarios
API del ERP). En desarrollo, las credenciales típicas son las siguientes:
| Campo | Valor |
|---|---|
| usuario | cb |
| password | 1234 |
| empresa | 7134 |
curl -X POST http://localhost/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"usuario": "cb", "password": "1234"}'La respuesta:
{
"data": {
"token": "3db0f42ecbb821ef103dc649...",
"empresa_id": 7134,
"empresa": "Xenon Industrial Articles",
"usuario_id": 20712,
"expires_at": "2026-03-20T21:32:31"
},
"meta": {},
"errors": null
}Guarda token — lo necesitas para todo lo demás. Vive 24 horas y se
puede renovar con POST /auth/refresh (idempotente si quedan más de 4h).
2. Hacé tu primer GET
Listemos las monedas (catálogo global, nivel 1):
TOKEN="3db0f42ecbb821ef103dc649..."
curl http://localhost/api/v1/Moneda \
-H "Authorization: Bearer $TOKEN"Recibirás un envelope estándar:
{
"data": [
{ "id": 1, "nombre": "Peso Mexicano", "abreviatura": "MXN" },
{ "id": 2, "nombre": "Dólar Estadounidense", "abreviatura": "USD" }
],
"meta": { "model": "Moneda", "total": 12, "page": 1, "per_page": 25, "pages": 1 },
"errors": null
}3. ¿Qué sigue?
- Autenticación a fondo — refresh, logout, invalidación.
- Multi-tenant — cómo el token determina la empresa.
- Niveles de modelos — qué modelos existen y por qué.
- Business Actions — operaciones no-CRUD como
autorizar_compra. - Referencia completa — todos los endpoints disponibles.