Im Menüpunkt API können die Zugriffsrechte der API‑Keys festgelegt werden. Mit den API‑Keys kann anschliessend auf die REST-API zugegriffen werden. Die REST-API ist unter https://demo.webling.ch/api/1 dokumentiert.
API Key erstellen
Klicke auf «Neuer API Key»
Anschliessend kannst du die Zugriffsrechte des API‑Keys festlegen. Ob der API‑Key Admin ist und alles darf, oder alles lesen, alles lesen und schreiben kann oder benutzerdefinierte Zugriffsrechte haben soll.
Hinweis: API‑Keys mit Admin-Berechtigungen sind normalerweise nicht zu empfehlen.
Wenn du die Option «Benutzerdefiniert» wählst, kannst du Rechte auf einzelne Mitgliedergruppen oder Mandanten setzen. Der Farbcode und die Icons zeigen dir zusätzlich an, welche Rechte gesetzt sind. Rot: Keine Rechte; Grün: Lese- oder Schreibrechte.
API Keys verwalten
API Keys bearbeiten geht über einen Klick auf das Schlüsselicon (1) oder über Markieren in der Liste und einen Klick auf «Bearbeiten». (2)
API Keys auslesen und bearbeiten
Im Bearbeiten-Dialog kann der eigentliche Key, eine 32-stellige Zeichenfolge, ausgelesen werden. Dieser wird benötigt, um auf die API zuzugreifen.
Zudem können hier Rechte und Beschreibung des Keys bearbeitet werden. Die Beschreibung kannst du frei wählen. Sie wird nur verwendet, um die verschiedenen Keys zu unterscheiden.
Wichtig: Sei vorsichtig, wenn du diesen API‑Key an Dritte weitergibst. Mit dem API-Key kann je nach Berechtigung alles ausgelesen oder gelöscht werden.