UJS - Universal JSON Storage

Diese Installation stellt eine REST API bereit, um JSON-Dokumente modulbasiert zu speichern, zu versionieren und abzufragen.

Der beste Einstieg ist die Swagger-Dokumentation unter /docs/. Einbindbare Beispiele für PHP, Shell und Python liegen im Ordner examples/.

UJS eignet sich als zentraler JSON-Speicher für interne Tools, Integrationen und Skripte. Authentifiziert wird per API-Token.

Was die API kann

JSON-Dokumente speichern

Daten werden als frei strukturierbares JSON gespeichert. Jeder Eintrag hat einen type, eine customer_no und ein data-Objekt.

Lesen, filtern und suchen

Einträge lassen sich per Query-Parameter nach type, customer_no, Tags und JSON-Feldern filtern.

Versionierung und Historie

Änderungen werden versioniert. Die API kann Einträge lesen, aktualisieren, Historie anzeigen und Versionen wiederherstellen.

Upserts über externe IDs

Module können einen JSON-Pfad als External-ID nutzen. Damit lassen sich Datensätze anhand fachlicher IDs erstellen oder aktualisieren.

Bulk-Import und Aggregation

Mehrere Einträge können in einem Request geschrieben werden. Aggregationen wie count, sum, avg, min und max sind ebenfalls verfügbar.

Tags und Verknüpfungen

Einträge können Tags erhalten und mit Einträgen anderer Module verknüpft werden.

Attachments

Dateien können an JSON-Einträge angehängt und später wieder abgerufen oder gelöscht werden.

Freigaben

Einträge können über Share-Links lesbar gemacht werden, optional mit Ablauf, View-Limit und IP-Einschränkung.

Webhooks und Events

Bei INSERT, UPDATE und DELETE können Webhooks ausgelöst werden. Zustellungen werden asynchron verarbeitet und erneut versucht.

DSGVO Export und Löschung

Kundendaten können modulübergreifend per customer_no exportiert oder gelöscht werden.

Clients und Skripte

Fertige Beispiele für PHP, Shell/cURL und Python zeigen, wie Projekte die API direkt nutzen können.

Maschinenlesbare Doku

Die API stellt OpenAPI JSON und eine Postman Collection bereit, damit Tools und Entwickler schnell starten können.