REST API
Paket: BASIS
1. Allgemein
Eine REST-API (Representational State Transfer Application Programming Interface) ist eine standardisierte Programmierschnittstelle, über die externe Systeme und Anwendungen auf Daten zugreifen und diese verarbeiten können.
brainX stellt eine REST API bereit, über die Datensätze aus brainX gelesen, erstellt, aktualisiert und gelöscht werden können. Die Schnittstelle richtet sich ausschließlich an Software-Entwickler mit entsprechendem Fachwissen und ermöglicht die Anbindung externer Systeme sowie die Automatisierung von Prozessen außerhalb von brainX.
Für die Anbindung von brainX an n8n steht eine offizielle, von n8n verifizierte Community Node zur Verfügung. Sie ermöglicht die Integration von brainX in n8n Workflows ohne manuelle API-Implementierung. Weitere Informationen sind auf der Seite n8n-Integration zu finden.
1.1. REST API Dokumentation
Die Dokumentation der REST API richtet sich nicht an brainX-Anwender oder brainX-Administratoren, sondern ausschließlich an Software-Entwickler/Programmierer mit entsprechendem Fachwissen.
Die Dokumentation der brainX REST API (Version 1.1.0) ist unter folgender URL aufrufbar: https://meine-brainx-domain/api/docs
Die URL setzt sich wie folgt zusammen: https:// gefolgt von der Domain der jeweiligen brainX-Instanz und dem Pfad /api/docs. Die Domain entspricht der URL, über die brainX im Browser aufgerufen wird.
Beispiel: Lautet die brainX-URL https://mustermann.brainx.app, dann ist die API-Dokumentation unter https://mustermann.brainx.app/api/docs abrufbar.
2. Authentifizierung
Der Zugriff auf die brainX REST API erfolgt über eine Basisauthentifizierung (Basic Auth) mit Benutzername und einem speziell generierten API-Passwort. Das API-Passwort ist nicht identisch mit dem Anmeldepasswort des Benutzers.
2.1. API-Passwort generieren
Das API-Passwort wird unter Meine Einstellungen generiert:
- In brainX zu Meine Einstellungen navigieren
- Im Abschnitt API-Passwort ein neues Passwort generieren
- Das Passwort sofort sichern – es wird nur einmalig nach der Generierung angezeigt und kann danach nicht mehr eingesehen werden
Es können mehrere API-Passwörter gleichzeitig aktiv sein. Es wird empfohlen, für jeden Use Case ein eigenes API-Passwort zu generieren. So kann bei einem Sicherheitsvorfall oder einer Änderung ein einzelnes Passwort deaktiviert oder ersetzt werden, ohne andere Integrationen zu beeinträchtigen.
2.2. Credentials
Für die Authentifizierung werden folgende Angaben benötigt:
| Feld | Beschreibung |
|---|---|
| Base URL | URL der brainX-Instanz, z. B. https://meine-brainx-domain |
| Benutzername | Benutzername des brainX-Benutzers |
| API-Passwort | Generiertes API-Passwort (nicht das Anmeldepasswort) |