Daten-Typ "API User"
Die API-User sind Teil des eCMS-Plugins "Plugin eCMS-API".
Im Folgenden sind die Standard-Datenfelder aufgeführt und erläutert.
In der Spalte "Feldname" ist jeweils der Name der Spalte, wie sie im eCMS Backend in Eingabe-Formularen und Listen-Ansichten dargestellt ist, zu sehen.
| Feldname | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| User Token | TEXT |
(Pflicht) Alphanumerischer eindeutige Zeichenkette, die diesen User identifiziert. Diese sollte aus Sicherheitsgründen möglichst lang (mindestens 32 Zeichen) sein und nur dem authorisierten API-aufrufendem System mitgeteilt werden. |
"dhskjh27ahdjhg46095hdn37dsn28fg28hsAH73G7228Vbqus73kds983r" |
| UAM Username | TEXT |
(Pflicht) Name des eCMS-Users, mit dem dieser API-User verknüpft wird. Dieser eCMS User muss zuvor in der eCMS-Userverwaltung (UAM) angelegt und mit (Daten-) Zugriffsrechten konfiguriert werden. Mehrere API-User können mit ein und demselben eCMS-User verknüpft werden. |
"api.user" |
| User Beschreibung | TEXT |
(Pflicht) Interner Name dieses API-Users. |
"API User (1)" |
| User Status | TEXT |
(Pflicht) "enabled" oder "disabled". Nur wenn der Status "enabled" ist, werden API-Zugriffe von außen für diesen User zugelassen. Hierüber kann man kurzfristig (und temporär) einfach einen User sperren, ohne gleich sämtliche Ressourcen- und API-Konfiguration löschen zu müssen. |
"enabled" |
|
User Settings: Nur von IP-Adresse |
TEXT | (Optional) Filter IP-Adresse. Wenn der API-Zugriff nur von einer gewissen IP-Adresse aus erfolgen darf, so kann diese hier angegeben werden. Dies dient natürlich der Sicherheit. | "123.321.189.212" |
|
User Settings: |
DATETIME |
(Optional) Aktivierungszeitraum, Startzeitpunkt. Wenn gesetzt, kann erst ab diesem Zeitpunkt von außen auf die Schnittstelle zugegriffen werden. |
"15.06.2013 18:00" |
|
User Settings: Aktiv bis |
DATETIME |
(Optional) Aktivierungszeitraum, Endzeipunkt. Wenn gesetzt, kann bis maximal zu diesem Zeitpunkt von außen auf die Schnittstelle zugegriffen werden. |
"31.12.2014 23:599" |