BBasic Handbuch

REST-API

Die REST-API unter http://docs.bbasic.de/api/v1 deckt alles ab, was die Oberfläche kann. Die interaktive Dokumentation steht unter /api/docs (Swagger UI).

Swagger UI: alle Endpunkte zum Ausprobieren

Abb.: Swagger UI: alle Endpunkte zum Ausprobieren

Anmelden

curl -s http://docs.bbasic.de/api/v1/auth/login -H "Content-Type: application/json" \
  -d '{"username":"anna","password":"…","persistent":true,"deviceName":"Importskript"}'
# → { "token": "bbh_…", … }

Wichtige Endpunkte

MethodePfadZweck
GET/projectslesbare Handbücher
GET/projects/{id}/treeInhaltsverzeichnis
GET/search?q=…Volltextsuche
GET/topics/{id}?includeBody=trueSeite lesen
POST/projects/{id}/topicsSeite anlegen
PATCH/topics/{id}nur gesetzte Felder ändern
POST/projects/{id}/mediaBild hochladen, optional insertInto
GET/topics/{id}/revisionsVerlauf
GET/projects/{id}/pdfPDF erzeugen

Fehler

HTTPBedeutung
401nicht angemeldet oder Token ungültig – kein stiller Rückfall auf anonym
403angemeldet, aber ohne Recht
404nicht gefunden – auch für Leser verborgene Seiten
503PDF nicht verfügbar (kein Edge/Chrome auf dem Server)
{ "error": "forbidden", "detail": "Schreibrecht für dieses Projekt oder Admin erforderlich." }

Weiterlesen

Zuletzt geändert am 19.11.2026Stichwörter: REST, API, JSON, Swagger, curl, Endpunkte

Meine Hinweise zu dieser Seite

Hier können Sie eigene Vermerke hinterlegen – nur für sich oder für Ihre Firma. Anmelden oder kostenloses Konto anlegen.