mitho -Framework für plenty PHP-Framework zur Anbindung an die plenty API

Transkript

1 PHP-Framework zur Anbindung an die plenty API

2 Inhaltsverzeichnis 1 Kurzbeschreibung Integration Möglichkeiten Artikel Aufträge Kunden Interne Funktionsweise Authentifizierung plenty php-klassen Konfiguration Lockfiles Datenbank Betriebsbedingungen Projektteam...10

3 1 Kurzbeschreibung 1 Kurzbeschreibung Das Framework wurde entwickelt, um eine schnelle Anbindung externer Systeme an plentymarkets zu realisieren. Die Schnittstelle dient als Adapter zu plenty und bietet eine vereinfachte Abstraktionsschicht zum Austausch der Daten zwischen plenty und der Außenwelt. Neue Systeme müssen nur noch an diese stark vereinfachte Schicht angeschlossen werden. 3/10

4 2 Integration 2 Integration Das Framework lässt sich als eigenständige Bibliothek einbinden und über eine bestimmte Einstiegsklasse verwenden. Diese Klasse bietet alle nötigen Methoden um mit plenty Daten auszutauschen, d. h. Entwickler brauchen nur diese eine Klasse zu kennen und müssen keine weiteren Kindklassen berücksichtigen um effizient zu arbeiten. Die bereitgestellten Methoden sind auf einige wenige reduziert und ausführlich dokumentiert, so dass erfahrene php-entwickler einen leichten Einstieg in das Framework haben. Die von plenty bereitgestellten API-Calls werden intern so weit wie möglich gekapselt und vereinfacht, so dass die Benutzung des Frameworks so minimalistisch wie möglich ausfällt. Das Framework selbst ist durch den ioncube Encoder verschlüsselt. Auf dem Zielserver muss daher der kostenlos erhältliche ioncube Loader installiert sein. Dessen Verbreitung ist mittlerweile sehr hoch und auf den meisten Servern problemlos installierbar. 4/10

5 3 Möglichkeiten 3 Möglichkeiten 3.1 Artikel Einfache Artikel sowie Varianten können sowohl aus plenty exportiert als auch zu plenty importiert werden. Die Importmethode ist so programmiert, dass Entwickler alle Felder übergeben können, die plenty im entsprechenden API-Call zum Anlegen von Artikeln zur Verfügung stellt. Zukünftige Felder werden automatisch berücksichtigt. Zusätzlich können im gleichen Call folgende Daten übergeben werden (die bei plenty sonst über mehrere verschiedene Calls verteilt sind): Varianten (inkl. Variantennummer) Lagerbestände Bilder mehrsprachige Texte Kategorien Hersteller Bei plenty z. Zt. leider nicht möglich ist das Übertragen von Preisaufschlägen bei Varianten. Dies wird evtl. in einer der kommenden Versionen von plenty implementiert. Beim Export können entweder alle vorhandenen Artikel abgefragt werden, oder aber gezielt nach Eigenschaften gefiltert werden (z. B. nach einer bestimmten Kategorie). Bei der Abfrage werden zu jedem Artikel zusätzlich die dazugehörigen Bilder und der Lagerbestand abgefragt. Intern werden hierzu drei verschiedene API- Calls benötigt, die in einer einzigen Methode zusammengefasst werden. Bilder können aber auch gezielt pro Artikel abgefragt werden. 3.2 Aufträge Bestellungen aus externen Systemen können zu plenty übermittelt werden, sofern diesem System die SKU der plenty-artikel bekannt sind. Hierbei werden einfache Artikel und Varianten unterstützt. Da Aufträge in plenty nur angelegt werden können, wenn der dazugehörige Käufer im System bekannt ist, werden Neukunden automatisch bei plenty angelegt und mit dem Auftrag verknüpft. 5/10

6 3 Möglichkeiten 3.3 Kunden Kunden können aber auch gezielt angelegt und geändert werden, dazu wird die gleiche Methode verwendet. Referenz ist die -Adresse des Kunden. Bei vorhandener -Adresse werden die Kundendaten geändert, ansonsten neu angelegt. 6/10

7 4 Interne Funktionsweise 4 Interne Funktionsweise Das Framework ist in php geschrieben und lässt sich als Bibliothek in jedes php-projekt einbinden. Durch die Verwendung von Namespaces (ab php 5.3) werden Namenskonflikte vermieden um die Integration in bestehende Systeme zu vereinfachen. 4.1 Authentifizierung SOAP-Anfragen müssen bei jedem Call vom plenty-server authentifiziert werden. Dies geschieht über eine Kombination aus User-ID und einem vom Server generierten Token. Dieser Token wird jeden Tag erneuert, darf aber nur in einer begrenzten Anzahl pro Tag abgefragt werden. Das Framework speichert daher den Token auf dem System, so dass er nur einmal täglich vom Server geholt werden muss. 4.2 plenty php-klassen Zur Abfrage der plenty-api werden für die Zusammenstellung der Request- Anfragen bestimmte php-klassen benötigt, die von plenty definiert sind. Diese Model-Klassen müssen für jede neue plenty-version einmalig neu generiert werden. Die Generierung kann innerhalb des Frameworks angestoßen werden. Mit Hilfe des xml-schemas der verwendeten Version werden diese Klassen automatisch erstellt und stehen dem System fortan zur Verfügung. Die Klassen selbst werden durch einen internen Autoloader automatisch eingebunden sobald von ihnen Gebrauch gemacht wird. 4.3 Konfiguration Die Konfiguration des Frameworks wird über eine ini-datei angepasst, die für jedes Projekt individuell angepasst werden kann. Dort werden u. A. die Zugangsdaten zum plenty-server und die verwendete API-Version hinterlegt. Auch eine Mindestversion der benötigten plenty-version wird hinterlegt um während des Betriebs auf veraltete plenty-installationen hinzuweisen. 4.4 Lockfiles Um Überschneidungen bei der Kommunikation mit plenty zu vermeiden werden innerhalb des Frameworks Lockfiles auf dem Server hinterlegt, so dass sich gleiche Vorgänge (wie z. B. Übertragung von Artikeln) nicht überlagern. 7/10

8 4 Interne Funktionsweise 4.5 Datenbank Um bei einigen Prozessen wertvolle Zeit zu sparen, werden bestimmte Daten in einer eigenen Datenbank lokal zwischengespeichert. So werden etwa einmal täglich die Länder-IDs von plenty abgefragt und gespeichert. Diese werden bei der Übertragung von Aufträgen verwendet. Die ID selbst besteht aus einer Ziffer, während viele Systeme Länderinformation als ISO-Code hinterlegen (z. B. de ). Da plenty aber die numerische ID aus dem eigenen System benötigt, wird diese in der Datenbank gespeichert und mit dem entsprechenden ISO- Code verknüpft. Als Datenbank wird SQLite verwendet, welches in php 5.3 schon integriert ist. Somit ist keine zusätzliche MySQL-Instanz nötig. 8/10

9 5 Betriebsbedingungen 5 Betriebsbedingungen Voraussetzung zum Betrieb der Schnittstelle ist ein Server, auf dem folgende Komponenten installiert sind: Apache 2 PHP 5.3 Für PHP müssen diese Erweiterungen installiert sein: ioncube Loader pdo_sqlite simplexml DOM curl SOAP Zusätzlich für PHP müssen diese Einstellungen gesetzt sein: memory_limit = 512M safe_mode = off max_execution_time = 300 Zweckes technischem Umgang mit dem Server wird außerdem vorausgesetzt: FTP- und SSH-Zugang Verwaltung von Cronjobs Optional: apc (zur Performancesteigerung) 9/10

10 6 Ansprechpartner 6 Ansprechpartner Projektmanager: H. Raschke h.raschke@mitho-media.de Weitere Infos finden Sie auf unserer Homepage: 10/10