IT-Naturschutz/konova
7
1
Fork 0
Code Issues 6 Pull Requests 1 Actions Projects Releases 28 Wiki Activity

„api_de“ hinzufügen

Michel Peltriaux 2022-01-27 14:44:53 +01:00
parent 3da51718d9
commit a281da7fd5
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
api_de.md Normal file

@ -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