From a281da7fd591438a679776953d52cced197114ac Mon Sep 17 00:00:00 2001 From: Michel Peltriaux Date: Thu, 27 Jan 2022 14:44:53 +0100 Subject: [PATCH] =?UTF-8?q?=E2=80=9Eapi=5Fde=E2=80=9C=20hinzuf=C3=BCgen?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api_de.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 api_de.md diff --git a/api_de.md b/api_de.md new file mode 100644 index 0000000..0f8182e --- /dev/null +++ b/api_de.md @@ -0,0 +1,11 @@ +# API +## Erste Schritte und Grundlagen +1. Nutzer muss mindestens der Nutzergruppe `Standard` angehören + 1. Eigene/Freigegebene Daten können eingesehen werden (`GET`) + 2. Neue Daten können angelegt (`POST`) und bestehende bearbeitet werden (`PUT`) + 3. Für eigene/freigegebene Daten kann die Liste der freigegebenen Nutzer eingesehen werden (`GET`) + 4. Daten können anderen Nutzern freigegeben werden + 1. **Achtung**: Wenn keine weitere Berechtigung außer der `Standard` Gruppe vorliegt, können Nutzer zur Liste der freigegebenen Nutzer lediglich **hinzugefügt** aber nicht entfernt werden. Zum Entfernen von Nutzern wird die Berechtigung `Zulassungsbehörde` oder `Eintragungsstelle` benötigt. +1. Nutzer muss sich einen API Token im KSP-Profil generieren + 1. Generierte Token müssen erst von Administratoren bestätigt werden. Vorher sind sie nicht gültig und können nicht verwendet werden. Administratoren werden automatisch nach Generierung eines neuen Token per Mail informiert. + 1. Token können von Administratoren zeitlich begrenzt werden. Ist das Datum der Gültigkeit abgelaufen, können die Token nicht länger verwendet werden