top of page

API per Programmi Terzi

Funzioni

La sezione API per programmi terzi consente di abilitare l’accesso in sola lettura ai dati raccolti da BusinessLog da parte di sistemi esterni autorizzati.

Questa funzione è pensata per integrazioni con strumenti come SIEM, EDR, XDR o altri software di analisi e monitoraggio.

Attraverso le API è possibile consultare informazioni come elenco macchine, eventi SOC, eventi falliti, sessioni utente, inventario software, eventi antivirus e revisioni dei log. Le operazioni disponibili sono esclusivamente in lettura: i programmi autorizzati possono quindi consultare i dati, ma non modificarli. La guida tecnica allegata conferma che le API BusinessLog permettono ai programmi autorizzati di consultare queste aree e che tutte le operazioni descritte sono in sola lettura

Api principale.png

Le API sono disabilitate di default.

Per abilitarle è necessario accedere alle Impostazioni di BusinessLog, individuare la sezione API per programmi terzi e attivare l’opzione Abilita API.

Nella stessa schermata è possibile configurare le porte utilizzate dal servizio per HTTP e HTTPS. Per gli accessi da altri computer deve essere utilizzato HTTPS, mentre HTTP è ammesso solo sul computer locale.

Programmi autorizzati

Per consentire l’accesso a un sistema esterno è necessario creare un nuovo programma tramite il pulsante Nuovo programma.

Ogni programma autorizzato dispone di una propria chiave API. La chiave identifica il programma durante le richieste verso BusinessLog e determina quali API può consultare.

La griglia mostra i programmi configurati, la data di inserimento, l’eventuale data di scadenza e lo stato Attivo. Una scadenza vuota indica che non è previsto un termine. 

Chiave API

API 2.png

Al momento della creazione di un nuovo programma, BusinessLog genera una chiave API.

La chiave viene mostrata soltanto in questa fase e deve essere copiata e conservata subito in un luogo sicuro.

Se viene persa, non può essere recuperata: sarà necessario rigenerarla. 

Il pulsante Rigenera chiave sostituisce immediatamente la chiave precedente.

Dopo la rigenerazione, la nuova chiave dovrà essere aggiornata nel programma esterno che effettua le chiamate.

​La chiave non deve essere inserita negli indirizzi URL o nei file di log.

API disponibili

API 3.png

Il pulsante API disponibili mostra l’elenco delle aree consultabili tramite API.

Le API disponibili sono:

  • AntivirusEvents: eventi antivirus;

  • FailedEvents: eventi falliti;

  • LogReviews: revisioni dei log;

  • MachineList: elenco macchine;

  • Soc: eventi SOC;

  • SoftwareInventory: inventario software;

  • UserSessions: sessioni utente.

La voce con asterisco * indica l’accesso a tutte le API.

I percorsi sono relativi all’indirizzo di base dell’installazione e tutte le richieste utilizzano il metodo GET. Il nome dell’API identifica anche l’area da utilizzare nelle autorizzazioni.

​

Autorizzazioni

API 4.png

Un programma attivo senza autorizzazioni specifiche accede a tutte le API disponibili, comprese quelle aggiunte in futuro.

Attraverso il pulsante Autorizzazioni è possibile definire eccezioni per il programma selezionato, consentendo o negando l’accesso a singole aree.

Una regola relativa a una singola area prevale sulla regola generale. Una regola disattivata o scaduta nega l’accesso a quell’area.

Se esistono più regole della stessa priorità, prevale il diniego.

Nell’esempio mostrato, il programma Pippo è autorizzato in generale, ma viene negato l’accesso all’Elenco macchine.

In questo modo il programma potrà consultare le altre aree, ma non l’elenco delle macchine.

Le autorizzazioni vengono salvate alla chiusura della finestra. Le scadenze seguono l’orario del server BusinessLog.

​

Verifica del servizio API

API 5.png

Per verificare rapidamente se il processo API risponde, è disponibile il percorso: /ping

Questa verifica può essere eseguita dal browser e non richiede la chiave API.

Il controllo mostra se il servizio è raggiungibile e se le API risultano abilitate in BusinessLog.

Sul computer che ospita BusinessLog, con la porta predefinita, è possibile aprire: http://localhost:5090/ping

Se la porta è diversa, sostituire 5090 con quella configurata.

Da un altro computer si utilizza invece l’indirizzo HTTPS dell’installazione seguito da /ping.

Con le API abilitate, la risposta mostra:

Accesso al servizio: OK
API Abilitate: Sì

Con le API disabilitate, la seconda riga diventa:

API Abilitate: No

Il codice HTTP resta comunque 200, perché il processo è in funzione anche quando l’accesso alle API dati è disabilitato.

​

Nota per gli integratori

Le API restituiscono risposte in formato JSON. Gli elenchi restituiscono un oggetto con la proprietà items; un elenco vuoto è una risposta valida con stato HTTP 200.

I nomi delle proprietà sono sempre in inglese e in formato camelCase, indipendentemente dalla lingua impostata in BusinessLog.

Per utilizzare le API dati, il programma integratore deve includere in ogni richiesta l’header: X-API-Key

La chiave deve essere quella assegnata al programma autorizzato.

​

Guida per utilizzatori e integratori: scarica pdf

​

bottom of page