IntegraciónPortal · Administrador

API para CMMS

El CMMS consulta stock en este inventario y registra consumos (salidas) contra el ledger.

Estado, clave API y endpoints disponibles
Estado, clave API y endpoints disponibles

Explicación de campos

Campo / controlQué esCómo usarlo
Estadoactivo / inactivo.Se activa al generar la clave.
ClaveVista abreviada de la API key o “aún no generada”.La clave completa solo se muestra una vez; en esta guía aparece como inv_********.
Generar API key / Regenerar API keyCrea o reemplaza la clave.Cópiela al momento. Regenerar invalida la anterior.
X-Api-KeyEncabezado que envía el CMMS.También acepta Authorization: Bearer inv_********.

Endpoints

Método y rutaUso
GET /api/v1/cmms/saludPrueba de conexión.
GET /api/v1/cmms/articulosCatálogo (admite ?q= para buscar).
GET /api/v1/cmms/stock?codigo=ART-001Stock por código (admite &bodega=).
GET /api/v1/cmms/stock/ART-001Stock por código en la ruta.
POST /api/v1/cmms/consumoRegistra una salida en el ledger.
{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "articuloCodigo": "ART-001",
  "cantidad": 2,
  "bodegaCodigo": "BOD-01",
  "centroCostoCodigo": "CC-220",
  "ordenTrabajo": "OT-8891"
}
✓
Consumouuid, articuloCodigo y cantidad son la base. Si no envía bodegaCodigo, se usa la primera bodega activa. Opcionales: ubicacionCodigo y notas.