Desarrolladores API v1

Endpoints de la API. Especificación exacta de cada operación de la API v1 (parámetros, cuerpo, respuestas y ejemplos), generada del documento OpenAPI con el que se valida cada respuesta real. Los procedimientos completos están en Guías.

Seguridad

Bitácora de auditoría

Los eventos de la bitácora encadenada de la empresa, en orden, para un SIEM. Cada evento trae seq, prev_hash y hash: hash = SHA-256(prev_hash ‖ JSON canónico RFC 8785 del evento sin prev_hash ni hash). Requiere el plan Enterprise y el alcance audit:read.

Operaciones

OperaciónMétodo y rutaAlcance
Eventos de la bitácora de auditoría GET /audit-events audit:read
Rutas de bitácora de auditoría

Objeto evento de auditoría

  • seq integer obligatorio

    Número de secuencia sin huecos.

  • occurred_at string obligatorio

    UTC con microsegundos y Z.

  • actor_type string obligatorio
    Valores: user, device, api_client, system, hub_admin
  • actor_id string | null
  • actor_label string | null
  • action string obligatorio
  • target_type string | null
  • target_id string | null
  • before objeto | array de textos | null
  • after objeto | array de textos | null
  • ip string | null
  • user_agent string | null
  • request_id string | null
  • prev_hash string obligatorio
  • hash string obligatorio
Objeto evento de auditoría 
{
    "seq": 1201,
    "occurred_at": "2026-10-17T16:30:00.123456Z",
    "actor_type": "user",
    "actor_id": "7",
    "actor_label": "Carlos Méndez",
    "action": "settings.changed",
    "target_type": "setting",
    "target_id": "receiving.over_tolerance_pct",
    "before": {
        "value": 5
    },
    "after": {
        "value": 7
    },
    "ip": "10.0.0.8",
    "user_agent": "Mozilla/5.0",
    "request_id": null,
    "prev_hash": "3f1c0b0e9d2a4c51b7f2a8e6d4c3b2a1908f7e6d5c4b3a291807f6e5d4c3b2a1",
    "hash": "9a8b7c6d5e4f30211f2e3d4c5b6a79880a1b2c3d4e5f60718293a4b5c6d7e8f9"
}