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.
2. REST API Dokumentation
Die Dokumentation der brainX REST API (Version 1.1.0) ist unter folgender URL aufrufbar: https://meine-brainx-domain/api/docs
Die Dokumentation der REST API richtet sich nicht an brainX-Anwender oder brainX-Administratoren, sondern ausschließlich an Software-Entwickler/Programmierer mit entsprechendem Fachwissen.