Dokumentation
Gehört zu jeder Installation dazu, nicht separat verkauft: die REST-API-Referenz für Integrationen sowie ein Administrations- und ein Benutzerhandbuch. Diese Seite halten wir synchron zum tatsächlichen Entwicklungsstand - keine Links, die ins Leere zeigen.
| Dokument | Inhalt | Format | Status |
|---|---|---|---|
| REST-API-Referenz | Versionierte, dokumentierte Endpunkte für Vorgänge, Abteilungen und Benutzer sowie Webhooks für Statusänderungen - inklusive API-Key-Verwaltung. | Aus dem Code generiert (OpenAPI-Spec, selbst gehostete Oberfläche) - bleibt automatisch synchron mit der tatsächlichen API, keine separat gepflegte Seite | Verfügbar - Bestandteil jeder Installation unter /api-dokumentation |
| Administrationshandbuch | Einrichtung, Abteilungen und Vorgangsvorlagen konfigurieren, Lizenz, Ollama-Anbindung, Benachrichtigungskanäle, DSGVO-Anonymisierung. | Eigenständige, druckbare HTML-Datei nach Vakowis-CI, mit Stand-Vermerk je Version | Verfügbar - Bestandteil jeder Installation unter /handbuecher/administrationshandbuch.html |
| Benutzerhandbuch | Für Mitarbeiter im täglichen Betrieb - Vorgänge melden, bearbeiten, übergeben, die Wissensdatenbank nutzen. | Eigenständige, druckbare HTML-Datei nach Vakowis-CI, mit Stand-Vermerk je Version | Verfügbar - Bestandteil jeder Installation unter /handbuecher/benutzerhandbuch.html |
Fragen zu einer konkreten Integration schon jetzt? Schreiben Sie uns - wir melden uns in der Regel innerhalb eines Werktags zurück.