Fachlichkeit

REST-Schnittstelle und Rechte

Die HTTP-Routen unter /crms, die Rollen, mit denen CRMS entscheidet, die eine Fehlerform mit Schlüsseln und der Client, mit dem eine Anwendung einen eigenen CRMS-Dienst aufruft.

CRMS hat eine HTTP-Schnittstelle unter /crms. Über sie rendern Anwendungen Berichte, ein Vorlagen-Editor bearbeitet Vorlagen, und berechtigte Personen lesen, prüfen und löschen endgültige Dokumente.

Die Schnittstelle selbst entscheidet fast nichts. Wer anfragt, sagt CIAS. Was diese Person darf, entscheiden die CRMS-Module anhand ihrer Rollen. Jeder Fehler kommt in derselben Form zurück, mit einem Schlüssel statt eines Satzes.

Die Endpunkte: alle Routen und wer sie aufrufen darf
Die Rollen: welche Rolle was erlaubt und woher CRMS sie kennt
Die Fehlerantwort: die eine Form, Schlüssel und Statuscodes
Der Client für den eigenen Dienst: crms-client, wenn CRMS nicht eingebettet läuft

Themen dieser Fachlichkeit

1.Die Endpunkte
Alle HTTP-Routen von CRMS unter /crms: rendern, Vorlagen bearbeiten und freigeben, endgültige Dokumente lesen und prüfen. Wo sie laufen, was sie annehmen und wer sie aufrufen darf.
2.Die Rollen
Welche Rolle in CRMS was erlaubt: Vorlagen schreiben je Scope, Freigabestufen, Dokumente lesen, festhalten und löschen. Wie CRMS die Rollen aus CIAS liest und wo du sie einstellst.
3.Die Fehlerantwort
Jeder Fehler von CRMS hat dieselbe Form: messageKey, code, layer und bei Bedarf violations. Welcher Schlüssel welchen Statuscode bekommt und wo alle Schlüssel stehen.
4.Der Client für den eigenen Dienst
crms-client spricht mit einem eigenen CRMS-Dienst über HTTP: dieselben Ports wie eingebettet, das Token der Person wird weitergereicht, Zeitgrenzen und Fehler kommen als dieselben Exceptions zurück.