Guía Rápida de Integración – Cloud API | Centro de Ayuda de Dersalis

Este artículo presenta una visión resumida sobre cómo integrar la Cloud API de Dersalis, permitiendo que equipos técnicos conecten sistemas internos con datos de incidentes en tiempo real e históricos.
La documentación completa puede solicitarse al final.

1. Visión General

La Cloud API permite:

Consultar incidentes históricos
Recibir eventos en tiempo real mediante Webhook
Reconstruir el ciclo de vida completo de cada incidente
Integrar datos en dashboards, ERPs, SOCs y sistemas propios

La integración se basa en dos mecanismos:

1) Consulta mediante endpoint (GET /incident)
2) Notificaciones en tiempo real vía Webhook

2. Tipos Auxiliares Principales

export type UnixTime = number;  export interface TimeOfDay {   hour: number;   minute: number; }  export interface TimeWindow {   startTime: TimeOfDay;   endTime: TimeOfDay;   active: boolean;   timeZone: string; }  export type NotificationChannel =   "whatsapp" | "sms" | "teams" | "slack";

3. Objeto Monitoring (resumen)

export interface Monitoring {   id: string;   name: string;   monitoredIndividualIdList: string[];   monitoredIndividualGroupIdList: string[];   timeWindow: TimeWindow;   riskSettings: any[];   notificationSettings: any[];   active: boolean; }

4. Objeto Incident (resumen)

export interface Incident {   id: string;   monitoring: Monitoring;   monitoredIndividual: {     id: string;     registrationCode: string;   };   state: "open" | "finished" | "closed";   openTimestamp: UnixTime;   finishTimestamp: UnixTime;   closeTimestamp: UnixTime;   severityLevel: number;   log: IncidentLifeCycleEvent[];   location?: any; }

5. Eventos del Ciclo de Vida (resumen)

export type IncidentLifeCycleEvent =   | { type: "create"; timestamp: UnixTime }   | { type: "finish"; timestamp: UnixTime }   | { type: "close"; timestamp: UnixTime }   | { type: "severity-level-change"; timestamp: UnixTime; newSeverityLevel: number }   | { type: "notification-report"; timestamp: UnixTime; channels: NotificationChannel[] }   | { type: "handling-report"; timestamp: UnixTime; handlingOperatorId: string }   | { type: "sample-data-ref"; timestamp: UnixTime; sampleDataId: string };

6. Consulta de Incidentes – GET /incident

GET /incident?start=1711900000000&end=1712000000000 Authorization: Bearer <token>

Retorna:

incidentes completos
logs
niveles de severidad
timestamps

Ideal para auditoría y sincronización.

7. Webhook – Eventos en Tiempo Real

Ejemplo:

{   "eventType": "create",   "timestamp": 1711920032000,   "incidentId": "abc-123",   "data": { } }

Tipos soportados:

create
finish
close
severity-level-change
notification-report
handling-report
sample-data-ref

8. Recomendaciones Operativas

Webhook para procesamiento en tiempo real
/incident para resiliencia y verificación
Procesamiento idempotente recomendado
Guardar eventos usando (incidentId, timestamp) como clave única

9. Solicitud de Documentación Completa

Si su equipo necesita:

definiciones completas
estructuras avanzadas
payloads detallados
reglas de comportamiento y estados

Puede solicitar la documentación técnica integral al equipo de Dersalis.