CustomCatalog API Interface

Benutzerhandbuch. Stand 16.09.2016

Mit Version 2.0 des Premium Contao Themes CustomCatalog Moduls (im weitern Verlauf kurz "CC") wurde eine modulare API Schnittstelle (Interface) hinzugefügt, die es ermöglicht Daten aus dem System (Export) oder in das System (Import) zu führen.

Darüber hinaus bietet der modulare Aufbau Entwicklern die Möglichkeit sowohl die Standard-API-Schnittstelle durch eigene Erweiterungen mit neuen Funktionien zu ergänzen, als auch die Integration vollständig autarker "neuer" API-Schnittstellen für das System bereitzustellen.

Dieses Benutzerhandbuch wird im Folgenden zwei paxisnahme Beispiele aufgreifen und damit den Arbeitsprozess "Workflow" im Contao-Backend darstellen.

Praxisbeispiel 1 wird den Export bestehender CC-Datensätze in das allgemeingültige CSV-Format darstellen.

Praxisbeispiel 2 zeigt den Import aus einer Datenquelle (hier die vorab erstellte CSV-Datei).

Ausblick

Dieses Benutzerhandbuch wird im weiteren Verlauf mit einem "Entwickler"-Teil ergänzt. Es wird anhand von Beispiel-Erweiterungen die Standard-API-Schnittstelle um neue Logiken ergänzt, als auch eine "neue" API-Schnittstelle in das System integriert.

Hinweis, Disclaimer

Die Nutzung der API-Technologie erfolgt auf eigene Gefahr. Falsch konfigurierte Schnittstellen, Hook-Anbindungen oder Datenquellen jedweder Art können zu Datenverlust führen.