Daten-Typ "API Ressource"

Dies ist eine allgemeine Datenfeld-Referenz für diesen Daten-Typ.

Übersicht

Die API-Ressourceen sind Teil des eCMS-Plugins "Plugin eCMS-API".

Im Folgenden sind die Standard-Datenfelder aufgeführt und erläutert.

Datenfelder

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 ID	TEXT	(Pflicht) Kennzeichnet, welcher API diese Ressourcen-Konfiguration zugeordnet werden soll.	"my_api_v1"
Ressourcen Label	TEXT	(Pflicht) Name, unter der die Funktion nach außen über die API aufrufbar sein soll	"my_api_function_abc"
Ressourcen Status	TEXT	(Pflicht) "enabled" oder "disabled". Nur wenn der Status "enabled" ist, werden API-Zugriffe auf diese Ressource von außen zugelassen. Hierüber kann man kurzfristig (und temporär) einfach eine Ressource sperren, ohne gleich sämtliche Ressourcen- und User-Konfiguration löschen zu müssen.	"enabled"
Ressourcen Komponenten Typ	TEXT	(Pflicht) Im Moment steht hier nur "function" zur Verfügung.	"function"
Ressourcen Komponente	TEXT	(Pflicht) Die eigentliche (PHP-Klasse und) Methode, die intern aufgerufen werden soll.	"plugin_ecs__ecs_order__order_getList"
Ressourcen Komponente Parameter: default	TEXT	(Optional) Vorbelegbare Default-Parameter für den Methoden-Aufruf. Eingabe im YAML Format.	fields: var_a: 123 var_b: "hello world"
Ressourcen Komponente Parameter: whitelist	TEXT	(Optional) Paramter-Array-Keys, die von außen als Aufrufparameter zugelassen sind (whitelisting). Nicht hier definierte Array-Keys werden aus den Aufrufparametern gelöscht. Eingabe im YAML Format.	fields: filter:
Ressourcen Komponente Parameter: statics	TEXT	(Optional) Überschreibende Paramter-Array-Keys und natürlich -Werte, die immer gesetzt werden, bevor die eigentliche Methode aufgerufen wird. Eingabe im YAML Format.	skip_validate: true skip_beautify: true
Ressourcen Antwort Type	TEXT	(Pflicht) "default" oder "streamer". Mit der Einstellung "default" wird das Ergebnis der Ressourcen Komponente (Result-Array) als JSON String zurückgeliefert. Mit dem Antwort-Type "streamer" kann eine Datei aus dem Komponenten-Ergebnis als Datei Download gestreamt werden. Dafür muss im "data" Bereich des Result-Arrays der absoluter Dateipfad zur Stream-Datei hinterlegt sein. Siehe "file_path_field" Parameter.	"default"
Ressourcen Antwort Parameter file_path_field	TEXT	(Optional, default: "file_path") Der "file_path_field" Parameter wird nur bei "streamer" Ressourcen verwendet. Über diesen Parameter kann der API mitgeteilt werden, in welchem Array-Key des "data" Bereichs des Result-Arrays der Dateipfad der Streamer-Datei hinterlegt ist. Beispiel: Wird der "file_path_field" Parameter auf "my_file_download" gesetzt, sucht die API in "$RESULT[data][my_file_download]" nach dem Dateipfad für den Streamer-Download.	"file_path"
Ressourcen Plugin	TEXT	(Optional) Die Einstellungen einer Ressource 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"