REST-API
Die ScryLab REST API ermöglicht es, Signaldaten aus Python, MATLAB, Julia oder jeder anderen Umgebung direkt über HTTP in ScryLab zu importieren.
Base URL
http://localhost:5678Info
Die API ist nur vom lokalen Rechner aus zugänglich. Es ist keine Authentifikation erforderlich.
Die API ist standardmäßig aktiviert. Sie können sie unter Einstellungen → Allgemein → Integrationen deaktivieren.
Endpoints
| Methode | Endpoint | Beschreibung |
|---|---|---|
GET | /api/status | Prüft ob ScryLab läuft |
POST | /api/signals/send | Signal senden (JSON, kleine Daten) |
POST | /api/signals/upload | Signal senden (Binary .npz/.mat, große Daten) |
POST | /api/signals/upload_batch | Mehrere Signale in einem Request |
POST | /api/plot | Signal per Name in den aktiven Plot einfügen |
Python- & MATLAB-Client
Wer Python oder MATLAB nutzt, kann mit den offiziellen Clients scrylab (Python) und scrylab-matlab (MATLAB) die Transportauswahl und Source-Verwaltung automatisch erledigen lassen.
Signale senden
ScryLab unterstützt drei Transportmethoden:
| Situation | Endpoint |
|---|---|
| Kleines Signal (< 50k Samples) | POST /api/signals/send (JSON) |
| Großes Signal | POST /api/signals/upload (Binary .npz oder .mat) |
| Viele Signale auf einmal | POST /api/signals/upload_batch |
Jedes Signal braucht eine target_source_id – die ID der Datenquelle, in die das Signal importiert werden soll. Diese kann über die GUI erstellt oder per POST /api/sources erzeugt werden.
Source-Verwaltung (intern)
Zwei Endpoints für das Auflesen und Anlegen von Datenquellen – werden intern vom Python- und MATLAB-Client verwendet:
| Methode | Endpoint | Beschreibung |
|---|---|---|
GET | /api/sources | Alle geladenen Datenquellen auflisten |
POST | /api/sources | Neue leere Datenquelle anlegen |