NeuroomNet-CMS für Software-Entwickler
Womit haben wir es hier zu tun?
Im Kern handelt es sich um ein Headless CMS. Das CMS stellt Inhalte über eine HTTP/REST-Schnittstelle bereit, wie sie dargestellt werden, entscheidet die jeweilige Anwendung. Eine generische Pflegeanwendung (/form) baut ihre Eingabeformulare dynamisch aus der Beschreibung der Daten auf.
Die Konfiguration des CMS erfolgt ausschließlich über die HTTP/REST-Schnittstelle. Auch die Datenpflege nutzt eine solche Schnittstelle, dieselbe, die auch die Pflegeanwendung verwendet.
Begriffe
| Begriff | Bedeutung |
|---|---|
| Namensraum | Erster Teil eines API-Namens, z. B. tutorial. Dient der Trennung von Mandanten und ist die Grenze für Rechte. |
| API | Beschreibung einer Objektklasse (Schema) samt der zugehörigen Datensätze, z. B. tutorial/demo1. Über eine API wird eine HTTP/REST-CRUD-Schnittstelle bereitgestellt. |
| Datensatz | Ein einzelnes Objekt einer API. |
| Feld | Eine Eigenschaft der Objektklasse, mit Datentyp und Prüfregeln. |
| Projekt, Anwendung | Optionale Angaben im Schema zur Gruppierung von APIs in der Projektansicht der Pflegeanwendung. |
Wie erfolgt die Konfiguration?
Eine API wird mit einer Beschreibung ihrer Objektklasse angelegt (POST), kann nachträglich verändert (PUT) und wieder gelöscht werden (DELETE). Weitere Aufrufe (GET) liefern die vorhandenen Namensräume, APIs und deren Beschreibung. Details: Konfiguration von APIs.
Warum mandantenfähig?
Der Name einer API besteht aus zwei Teilen, die in einer URL durch einen Schrägstrich getrennt sind, z. B. tutorial/demo1. Der erste Teil (tutorial) ist der Namensraum, der zweite (demo1) der in diesem Namensraum eindeutige Name der API.
Meist gibt es nur einen Endkunden, für den das CMS betrieben wird. Häufig erstellen aber mehrere Dienstleister Anwendungen für ein Projekt. Mandanten sind in diesem Fall die einzelnen Firmen, die jeweils eigene Namensräume für ihre Anwendungen verwenden. Für eindeutige Namen eignet sich z. B. das Schema der umgekehrten Domänennamen, wie es in der Android- und Java-Welt üblich ist.
Wie werden Daten gepflegt?
Ist eine API angelegt, steht automatisch eine HTTP/REST-CRUD-Schnittstelle zur Pflege ihrer Datensätze bereit. Beim Anlegen (POST) und Ändern (PUT) werden die Daten gegen die Beschreibung der Objektklasse geprüft. Grundlage dafür ist der fastest-validator, der in Client und Server eingesetzt wird. Die Pflegeanwendung kann damit nicht nur passende Formulare aufbauen, sondern auch bereits vorab prüfen. Einige Prüfungen sind allerdings nur im Server möglich.
Details: Datenschnittstelle.
Welchen Zugriffsschutz gibt es?
Der Zugriff erfolgt ausschließlich verschlüsselt und erfordert immer eine Anmeldung. Ein Rechtesystem auf Basis der Namensräume trennt Mandanten und schränkt den Zugriff auf Daten ein. Unterschieden wird zwischen Lese- und Schreibrechten auf ganze Datensätze, Rechte auf einzelne Felder gibt es nicht.
Details: Rechte und Konten, Anmeldung.
Wie fängt man am besten an?
- Der Schnelleinstieg zeigt die ersten Schritte und vermittelt die wenigen Grundlagen für die Kommunikation mit dem CMS.
- Danach lohnt ein Blick auf das Rechtekonzept.
- Mit der Konfiguration von APIs und den Datentypen weiß man alles Nötige, um das CMS einzurichten.
- Das sind aber Einmalaktionen. Im Alltag zählt vor allem die Datenschnittstelle mit den Abfragen, über die Anwendungen ihre Inhalte beziehen.
Wer das CMS für ein Projekt erst einordnen möchte, beginnt mit dem Überblick.
Wo finde ich das CMS?
In einer NeuroomNet-Installation läuft ein lokales CMS. Die Adresse lautet https://<Name oder IP des Servers>:444, die Pflegeanwendung liegt unter /form. Daneben kann ein CMS im Internet betrieben werden, etwa während der Entwicklungsphase eines Projekts. Die konkrete Adresse nennt der Betreiber.
In den Beispielen dieser Dokumentation steht https://cms.example.org für die Adresse des CMS.