Tecnica e integrazioni

Modulo API di eBrigade

Colleghi eBrigade al Suo sistema informativo

Basta reinserire personale, turni e qualifiche da uno strumento all'altro. L'API di eBrigade espone i vostri dati tramite flussi in entrata e in uscita documentati e protetti da chiave: il vostro sistema HR (HRIS), il software paghe o il portale interno si sincronizzano automaticamente, senza sviluppi su misura lato eBrigade.

Incluso in tutti i piani

Incluso senza costi aggiuntivi in tutti i piani eBrigade, prova di 30 giorni senza carta di credito.

Il modulo API in 20 secondi

Illustrazione · dati di esempio

Cos'è il modulo API di eBrigade?

Chiavi API di importazione/esportazione, API REST v2 e flussi in entrata/uscita per collegare eBrigade al Suo sistema informativo. È incluso senza costi aggiuntivi in tutti i piani eBrigade.

Perché usare l'API?

I Suoi dati eBrigade restano isolati dagli altri strumenti: sistema HR, software paghe, gestionale o portale web. Ogni export Excel manuale, ogni reinserimento di un dipendente o di una qualifica richiede tempo e finisce per creare discrepanze tra le banche dati. Senza un accesso programmatico, il Suo reparto IT non ha un modo affidabile per tenere eBrigade allineato al sistema informativo di riferimento.

Cosa cambia l'API in eBrigade

L’API espone personale, attività e partecipazioni, competenze e relative scadenze, organizzazioni, iscrizioni, disponibilità e assenze, timbrature, veicoli e materiale tramite flussi standardizzati. I vostri sviluppatori leggono questi dati (GET) e inviano dati dai vostri strumenti esterni (POST) con una semplice chiave. La REST API v2 restituisce JSON coerente, paginato e autodocumentato; ogni chiamata è conteggiata, limitata e riportata in una dashboard di utilizzo, e l’accesso può essere ristretto ai soli vostri indirizzi IP.

Funzionalità

Cosa si può fare con API

Una chiave di importazione e una di esportazione sotto il Suo controllo

Due chiavi distinte — una per i flussi in entrata (import), una per quelli in uscita (export) — si generano e rigenerano in un clic dall'area di amministrazione. Rigenerare una chiave compromessa invalida subito la precedente, senza toccare l'altro flusso.

Flussi in entrata per sincronizzare i Suoi dati

Invii personale, attività/corsi di formazione e competenze a eBrigade dal Suo sistema HR o dall'anagrafica di riferimento. L'importazione gestisce aggiornamenti e creazioni (create_if_not_exists) e la corrispondenza per ID interno o ID esterno (use_external_id), UUID compresi.

Flussi in uscita per alimentare il Suo sistema informativo

Esponga in sola lettura personale, attività e partecipazioni su un periodo, il repertorio delle competenze e le scadenze di ciascuno, le sue organizzazioni, le iscrizioni alle attività a pagamento, disponibilità, assenze e timbrature, oltre a veicoli e attrezzature. Ideale per alimentare le paghe, la reportistica o una dashboard di business intelligence.

API REST v2 moderna e autodocumentata

Autenticazione tramite l'header Authorization: Bearer, risposte JSON uniformi {success, data, meta}, paginazione (page, per_page), aggiornamenti parziali di una scheda con PATCH, header CORS e codici HTTP espliciti. Endpoint, parametri ed esempi cURL sono documentati direttamente nell'interfaccia, senza documentazione esterna.

Quote e cruscotto di utilizzo

L'istanza ha un limite (per impostazione predefinita 10.000 richieste/giorno e 60 richieste/minuto per chiave) con intestazioni X-RateLimit e una risposta HTTP 429 in caso di superamento. Una dashboard mostra le richieste del giorno, la quota residua, l'ultimo endpoint chiamato e l'ora dell'ultima chiamata.

Accesso limitato a un elenco di indirizzi IP autorizzati

Attivate il filtro per indirizzo IP per accettare chiamate solo dai server autorizzati: ogni richiesta da un IP non presente nella allowlist viene rifiutata (HTTP 403), anche con una chiave valida.

E inoltre: Nuovi dati esportati · Libreria di connettori

In immagini

API nell'app

Schermate dell'applicazione reale, non mock-up.

eBrigade, Modulo API — chiavi api e quote : Una chiave per i flussi in entrata, un’altra per quelli in uscita, rigenerabili con un clic, con l’utilizzo di oggi e il limite attuale.
Chiavi API e quoteUna chiave per i flussi in entrata, un’altra per quelli in uscita, rigenerabili con un clic, con l’utilizzo di oggi e il limite attuale.
eBrigade, Modulo API — gli endpoint documentati : Personale, attività, partecipazioni, competenze, organizzazioni, disponibilità: ogni risorsa con il proprio metodo e i propri parametri.
Gli endpoint documentatiPersonale, attività, partecipazioni, competenze, organizzazioni, disponibilità: ogni risorsa con il proprio metodo e i propri parametri.
eBrigade, Modulo API — esempi di chiamate pronti da copiare : Richieste complete per ogni flusso: il Suo team tecnico non deve indovinare il formato atteso.
Esempi di chiamate pronti da copiareRichieste complete per ogni flusso: il Suo team tecnico non deve indovinare il formato atteso.
Come funziona

Passo dopo passo

  1. Generate le vostre chiavi API

    Dall'area di amministrazione, attivate l'API di export e generate con un clic la chiave di export e il token di import. Potete rigenerarli in qualsiasi momento per revocare l'accesso.

  2. Bloccare e testare gli accessi

    Se necessario, attivi la restrizione a un elenco di indirizzi IP autorizzati, poi testi le chiamate con gli esempi cURL forniti nell’interfaccia per ogni endpoint (persone, eventi, competenze, sezioni, iscrizioni).

  3. Colleghi i Suoi strumenti e monitori

    Il Suo sistema informativo interroga (GET) o invia (POST) dati attraverso i flussi documentati. La dashboard di utilizzo mostra le richieste del giorno, la quota residua e l’ultima chiamata, per tenere d’occhio le integrazioni.

FAQ del modulo

Domande frequenti

Uno strumento esterno può scrivere nel registro operativo?

Sì. L’API v2 accetta un messaggio nel diario di bordo di un’attività (POST /api/v2/events/{id}/logbook): testo, titolo, ora, importanza e nome dello strumento, mostrato come mittente. Un identificativo di riferimento rende la chiamata idempotente: lo stesso avviso inviato due volte crea una sola riga. Il diario si rilegge allo stesso indirizzo, con un filtro “since”. La scrittura richiede l’attivazione dell’API di importazione.

Quali tipi di dati sono accessibili tramite l'API?

Accesso in lettura (flussi in uscita): personale, attività e partecipazioni su un periodo, elenco delle competenze e date di scadenza delle competenze possedute, organizzazioni, iscrizioni ad attività a pagamento, disponibilità, assenze, timbrature, parco veicoli e attrezzature. Accesso in scrittura (flussi in entrata): importazione e aggiornamento del personale (scheda intera o solo i campi inviati, con PATCH), importazione di attività/corsi di formazione e assegnazione di competenze.

Quante chiavi API si possono creare?

L’API si basa su due chiavi: una per l’esportazione (flussi in uscita) e un token per l’importazione (flussi in entrata). Ciascuna viene generata e rigenerata in modo indipendente dall’area di amministrazione. Nell’API v2 una sola chiave può servire a entrambi gli scopi tramite l’header Authorization: Bearer.

Esiste un’API REST moderna o bisogna usare il vecchio formato?

Versione 2: la vecchia versione 1 non è più offerta, i suoi endpoint restano solo per le integrazioni esistenti. L'API v2 aggiunge autenticazione Bearer, JSON standardizzato {success, data, meta}, paginazione, header CORS e codici HTTP espliciti, restando retrocompatibile con gli endpoint v1 esistenti.

Ci sono limiti di frequenza delle richieste?

Sì. Per impostazione predefinita l’istanza è limitata a 10.000 richieste al giorno e ogni chiave a 60 richieste al minuto. Le risposte includono gli header X-RateLimit e restituiscono un codice HTTP 429 al superamento del limite. Una dashboard di utilizzo segue i vostri consumi in tempo reale.

Come è protetto l’accesso all’API?

Oltre alla chiave, potete attivare la restrizione a una lista di indirizzi IP autorizzati: ogni chiamata da un IP non in elenco viene rifiutata (HTTP 403). L'autenticazione avviene preferibilmente tramite header Bearer anziché in chiaro nell'URL.

Provi eBrigade con il modulo API

Prova eBrigade di 30 giorni · Nessuna carta richiesta · Modulo incluso nel piano

Modulo incluso in eBrigade Prova eBrigade di 30 giorni · Nessuna carta richiesta · Incluso nel piano
Prova gratuita di 30 giorni