API para Programas de Terceros
Funzioni
La sección API para programas de terceros permite habilitar el acceso de solo lectura a los datos recopilados por BusinessLog por parte de sistemas externos autorizados.
Esta función está diseñada para integraciones con herramientas como SIEM, EDR, XDR u otros programas de análisis y monitorización.
A través de las API es posible consultar información como la lista de equipos, los eventos SOC, los eventos fallidos, las sesiones de usuario, el inventario de software, los eventos de antivirus y las revisiones de los registros. Las operaciones disponibles son exclusivamente de lectura: por tanto, los programas autorizados pueden consultar los datos, pero no modificarlos.
La guía técnica adjunta confirma que las API de BusinessLog permiten a los programas autorizados consultar estas áreas y que todas las operaciones descritas son de solo lectura.
Las API están deshabilitadas de forma predeterminada.
Para habilitarlas, es necesario acceder a la Configuración de BusinessLog, localizar la sección API para programas de terceros y activar la opción Habilitar API.
En la misma pantalla es posible configurar los puertos utilizados por el servicio para HTTP y HTTPS. Para los accesos desde otros equipos debe utilizarse HTTPS, mientras que HTTP solo está permitido en el equipo local.
Programas autorizados
Para permitir el acceso a un sistema externo, es necesario crear un nuevo programa mediante el botón Nuevo programa.
Cada programa autorizado dispone de su propia clave API. La clave identifica el programa durante las solicitudes a BusinessLog y determina qué API puede consultar.
La tabla muestra los programas configurados, la fecha de creación, la posible fecha de caducidad y el estado Activo. Una fecha de caducidad vacía indica que no se ha establecido ningún plazo.
Clave API
Al crear un nuevo programa, BusinessLog genera una clave API.
La clave se muestra únicamente en esta fase y debe copiarse y guardarse inmediatamente en un lugar seguro.
Si se pierde, no puede recuperarse: será necesario regenerarla.
El botón Regenerar clave sustituye inmediatamente la clave anterior.
Después de regenerarla, la nueva clave deberá actualizarse en el programa externo que realiza las solicitudes.
La clave no debe incluirse en las direcciones URL ni en los archivos de registro.
API disponibles
El botón API disponibles muestra la lista de las áreas que se pueden consultar a través de las API.
Las API disponibles son:
-
AntivirusEvents: eventos de antivirus;
-
FailedEvents: eventos fallidos;
-
LogReviews: revisiones de los registros;
-
MachineList: lista de equipos;
-
Soc: eventos SOC;
-
SoftwareInventory: inventario de software;
-
UserSessions: sesiones de usuario.
La opción marcada con un asterisco (*) indica el acceso a todas las API.
Las rutas son relativas a la dirección base de la instalación y todas las solicitudes utilizan el método GET. El nombre de la API también identifica el área que debe utilizarse en las autorizaciones.
Autorizaciones
Un programa activo sin autorizaciones específicas puede acceder a todas las API disponibles, incluidas las que se añadan en el futuro.
Mediante el botón Autorizaciones es posible definir excepciones para el programa seleccionado, permitiendo o denegando el acceso a áreas específicas.
Una regla relativa a un área específica tiene prioridad sobre la regla general. Una regla deshabilitada o caducada deniega el acceso a dicha área.
Si existen varias reglas con la misma prioridad, prevalece la denegación.
En el ejemplo mostrado, el programa Pippo está autorizado de forma general, pero se le deniega el acceso a la Lista de equipos.
De este modo, el programa podrá consultar las demás áreas, pero no la lista de equipos.
Las autorizaciones se guardan al cerrar la ventana. Las fechas y horas de caducidad se basan en la hora del servidor de BusinessLog.
Verificación del servicio API
Para comprobar rápidamente si el proceso de la API responde, está disponible la siguiente ruta: /ping
Esta comprobación puede realizarse desde el navegador y no requiere una clave API.
La verificación muestra si el servicio es accesible y si las API están habilitadas en BusinessLog.
En el equipo que aloja BusinessLog, utilizando el puerto predeterminado, puede abrirse:
Si se ha configurado un puerto diferente, sustituya 5090 por el número de puerto configurado.
Desde otro equipo, debe utilizarse la dirección HTTPS de la instalación seguida de /ping.
Con las API habilitadas, la respuesta muestra:
Acceso al servicio: OK
API habilitadas: Sí
Con las API deshabilitadas, la segunda línea pasa a ser:
API habilitadas: No
El código de estado HTTP sigue siendo 200, ya que el proceso está en funcionamiento incluso cuando el acceso a las API de datos está deshabilitado.
Nota para los integradores
Las API devuelven respuestas en formato JSON. Las listas devuelven un objeto con la propiedad items; una lista vacía es una respuesta válida con un código de estado HTTP 200.
Los nombres de las propiedades están siempre en inglés y utilizan el formato camelCase, independientemente del idioma configurado en BusinessLog.
Para utilizar las API de datos, el programa integrador debe incluir el siguiente encabezado en cada solicitud:
X-API-Key
La clave debe ser la asignada al programa autorizado.
Guía para usuarios e integradores: descargar PDF