Techniek & koppelingen

eBrigade-module API

Koppel eBrigade aan uw informatiesysteem

Stop met het opnieuw invoeren van personeel, roosters en kwalificaties van de ene tool in de andere. De eBrigade-API stelt uw gegevens beschikbaar via gedocumenteerde inkomende en uitgaande feeds, beveiligd met een sleutel: uw HR-systeem (HRIS), salarissoftware of intern portaal synchroniseren automatisch, zonder maatwerk aan eBrigade-zijde.

Inbegrepen in elk abonnement

Zonder meerkosten inbegrepen in elk eBrigade-abonnement, 30 dagen gratis proberen zonder creditcard.

De API-module in 20 seconden

Illustratie · voorbeeldgegevens

Wat is de module API van eBrigade?

API-sleutels voor import/export, REST API v2 en in- en uitgaande feeds om eBrigade aan uw informatiesysteem te koppelen. Zonder meerkosten inbegrepen in elk eBrigade-abonnement.

Waarom de API gebruiken?

Uw eBrigade-gegevens staan los van uw andere tools: HR-systeem, salarissoftware, bedrijfssoftware of webportaal. Elke handmatige Excel-export, elke herinvoer van een medewerker of kwalificatie kost tijd en leidt uiteindelijk tot verschillen tussen uw databases. Zonder programmatische toegang hebben uw IT-teams geen betrouwbare manier om eBrigade gelijk te houden met uw centrale informatiesysteem.

Wat de API verandert in eBrigade

De API ontsluit uw personeel, uw activiteiten en deelnames, uw vaardigheden en hun vervaldata, uw organisaties, uw inschrijvingen, uw beschikbaarheid en afwezigheden, uw tijdregistraties, uw voertuigen en uw materieel via gestandaardiseerde feeds. Uw ontwikkelaars lezen deze gegevens (GET) en sturen gegevens terug vanuit uw andere tools (POST) met een eenvoudige sleutel. REST API v2 levert consistente, gepagineerde, zelfdocumenterende JSON; elke aanroep wordt geteld, begrensd en gerapporteerd in een verbruiksdashboard, en de toegang kan worden beperkt tot uw eigen IP-adressen.

Functies

Wat u kunt doen met API

Een importsleutel en een exportsleutel onder uw beheer

Twee aparte sleutels — één voor inkomende feeds (import), één voor uitgaande feeds (export) — worden met één klik gegenereerd en vernieuwd in het beheergedeelte. Een gecompromitteerde sleutel vernieuwen maakt de oude direct ongeldig, zonder de andere feed te raken.

Inkomende feeds om uw gegevens te synchroniseren

Stuur uw personeel, activiteiten/opleidingen en competenties naar eBrigade vanuit uw hr-systeem of referentiebestand. De import verwerkt zowel updates als aanmaak (create_if_not_exists) en koppeling op interne of externe ID (use_external_id), inclusief UUID's.

Uitgaande koppelingen voor uw informatiesysteem

Stel alleen-lezen beschikbaar: uw personeel, activiteiten en deelname over een periode, de vaardighedenlijst en de vervaldata per persoon, uw organisaties, inschrijvingen voor betaalde activiteiten, beschikbaarheid, afwezigheden en prikklokregistraties, en ook uw voertuigen en materieel. Ideaal voor salarisadministratie, rapportage of een business-intelligencedashboard.

Moderne, zelfdocumenterende REST API v2

Authenticatie via de header Authorization: Bearer, uniforme JSON-antwoorden {success, data, meta}, paginering (page, per_page), gedeeltelijke updates van een record met PATCH, CORS-headers en expliciete HTTP-codes. Endpoints, parameters en cURL-voorbeelden staan direct in de interface gedocumenteerd, zonder externe documentatie.

Quota en gebruiksdashboard

De instantie is begrensd (standaard 10.000 verzoeken per dag en 60 verzoeken per minuut per sleutel), met X-RateLimit-headers en een HTTP 429-antwoord bij overschrijding. Een dashboard toont de verzoeken van de dag, het resterende quotum, het laatst aangeroepen endpoint en het tijdstip van de laatste aanroep.

Toegang beperkt tot een lijst van toegestane IP-adressen

Schakel IP-filtering in om alleen oproepen van geautoriseerde servers te aanvaarden: elk verzoek van een IP buiten de allowlist wordt geweigerd (HTTP 403), zelfs met een geldige sleutel.

En verder: Nieuwe geëxporteerde gegevens · Connectorbibliotheek

In beeld

API in de app

Schermafbeeldingen van de echte applicatie, geen mock-ups.

eBrigade, Module API — api-sleutels en quota : Eén sleutel voor inkomende feeds, een andere voor uitgaande feeds, met één klik te vernieuwen, met het gebruik van vandaag en de huidige limiet.
API-sleutels en quotaEén sleutel voor inkomende feeds, een andere voor uitgaande feeds, met één klik te vernieuwen, met het gebruik van vandaag en de huidige limiet.
eBrigade, Module API — de gedocumenteerde endpoints : Personeel, activiteiten, deelnames, competenties, organisaties, beschikbaarheid: elke resource met haar methode en parameters.
De gedocumenteerde endpointsPersoneel, activiteiten, deelnames, competenties, organisaties, beschikbaarheid: elke resource met haar methode en parameters.
eBrigade, Module API — kant-en-klare voorbeeldaanroepen om te kopiëren : Volledige verzoeken voor elke feed: uw technische team hoeft niet te raden welk formaat verwacht wordt.
Kant-en-klare voorbeeldaanroepen om te kopiërenVolledige verzoeken voor elke feed: uw technische team hoeft niet te raden welk formaat verwacht wordt.
Hoe het werkt

Stap voor stap

  1. Genereer uw API-sleutels

    Schakel vanuit het beheergedeelte de export-API in en genereer met één klik de exportsleutel en het importtoken. U kunt ze op elk moment opnieuw genereren om toegang in te trekken.

  2. Toegang afschermen en testen

    Schakel desgewenst de beperking tot een lijst toegestane IP-adressen in en test daarna uw aanroepen met de cURL-voorbeelden die in de interface per endpoint worden gegeven (personen, evenementen, competenties, afdelingen, inschrijvingen).

  3. Koppel uw tools en monitor

    Uw informatiesysteem vraagt gegevens op (GET) of stuurt ze door (POST) via de gedocumenteerde feeds. Het gebruiksdashboard toont de aanvragen van de dag, het resterende quotum en de laatste aanroep, zodat u uw koppelingen in de gaten houdt.

FAQ over de module

Veelgestelde vragen

Kan een externe tool in het logboek schrijven?

Ja. API v2 accepteert een bericht in het logboek van een activiteit (POST /api/v2/events/{id}/logbook): tekst, titel, tijdstip, belang en de naam van de tool, getoond als afzender. Een referentie-ID maakt de aanroep idempotent: dezelfde melding twee keer verstuurd levert één regel op. Het logboek wordt op hetzelfde adres teruggelezen, met een filter “since”. Schrijven vereist dat de import-API is ingeschakeld.

Welke soorten gegevens zijn via de API toegankelijk?

Leestoegang (uitgaande koppelingen): personeel, activiteiten en deelname over een periode, de referentielijst van competenties en de vervaldata van behaalde competenties, organisaties, inschrijvingen voor betaalde activiteiten, beschikbaarheid, afwezigheden, prikklokregistraties, het wagenpark en materieel. Schrijftoegang (inkomende koppelingen): import en update van personeel (volledig dossier of alleen de verzonden velden, met PATCH), import van activiteiten/opleidingen en toekenning van competenties.

Hoeveel API-sleutels kunnen er worden aangemaakt?

De API werkt met twee sleutels: één voor export (uitgaande feeds) en een token voor import (inkomende feeds). Elk wordt los van de ander aangemaakt en vernieuwd vanuit de beheeromgeving. In API v2 kan één sleutel beide doelen dienen via de header Authorization: Bearer.

Is er een moderne REST API, of moet u het oude formaat gebruiken?

Versie 2: de oude versie 1 wordt niet meer aangeboden, de endpoints blijven alleen voor bestaande koppelingen. API v2 voegt Bearer-authenticatie toe, gestandaardiseerde JSON {success, data, meta}, paginering, CORS-headers en expliciete HTTP-codes, en blijft compatibel met de bestaande v1-endpoints.

Zijn er limieten op het aantal verzoeken?

Ja. Standaard is de instantie begrensd op 10.000 aanroepen per dag en elke sleutel op 60 aanroepen per minuut. Antwoorden bevatten X-RateLimit-headers en geven een HTTP 429-code terug bij overschrijding. Een gebruiksdashboard volgt uw verbruik realtime.

Hoe is de toegang tot de API beveiligd?

Naast de sleutel kunt u beperking tot een toegestane lijst van IP-adressen inschakelen: elke aanroep vanaf een IP-adres dat niet op de lijst staat, wordt geweigerd (HTTP 403). Authenticatie gebeurt bij voorkeur via een Bearer-header in plaats van leesbaar in de URL.

Probeer eBrigade met de module API

eBrigade 30 dagen proberen · Geen kaart nodig · Module inbegrepen in uw abonnement

Module inbegrepen in eBrigade eBrigade 30 dagen proberen · Geen kaart nodig · Inbegrepen in het abonnement
30 dagen gratis proberen