Daten-Typ "API"
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 |
|---|---|---|---|
| API Label | TEXT |
(Pflicht) Alphanumerischer eindeutige Zeichenkette, die diese API kennzeichnet |
"my_api_v1" |
| API Beschreibung | TEXT |
(Pflicht) Interner Name dieser API. |
"My API - V1.0" |
| API Status | TEXT |
(Pflicht) "enabled" oder "disabled". Nur wenn der Status "enabled" ist, werden API-Zugriffe von außen für diese API zugelassen. Hierüber kann man kurzfristig (und temporär) einfach eine gesamte API abschalten, ohne gleich sämtliche Ressourcen- und User-Konfiguration löschen zu müssen. |
"enabled" |
|
API Settings: Nur SSL (HTTPS) |
TEXT | (Pflicht) "yes" oder "no". Wenn die Einstelung "yes" ist, werden nur SSL-verschlüsselte API-Zugriffe von außen zugelassen. | "yes" |
|
API 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" |
|
API 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" |
|
API 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" |
|
API Settings: API Plugin |
TEXT | (Optional) Die Einstellungen einer API können einem (eigenen) eCMS-Plugin zugeordnet werden, um somit leichter exportiert und auf anderen System importiert werden zukönnen | "ecms_my_api_config_v1" |