API Magentoeinbindung
Aus Faktura-XP Warenwirtschaft Handbuch und Wiki
Inhaltsverzeichnis
|
Wie erstelle ich bei Magento einen Zugang zur Schnittstelle?
Für einen Zugriff über die eingebaute API /SOAP Schnittstelle des Magento® Shop müssen Sie zunächst im Adminbereich des Shop einen neuen Benutzer einrichten, der als legitimierter Benutzer für den Datenabruf von außen berechtigt ist. Der bereits bei der Installation des Magento-Shop angelegte Benutzer "Admin" ist nicht für den Zugriff geeignet.
Der API Zugriff mit dem "Standard Admin" als Benutzer ist nicht möglich.
Neben den Benutzerdaten für den Zugriff auf den Shop werden auch die FTP Zugangsdaten des Server benötigt. Diese dienen bei Eingabe in Faktura-XP lediglich dazu, die Schnittstellen Scripte auf den Webserver laden zu können. Es ist auch möglich ohne Eingabe der FTP Daten die Bestellungen und Artikel vom Shop abzurufen. Dazu müssen dann die Schnittstellen Scripte mit einem separaten FTP Programm auf den Server geladen werden. Lesen Sie dazu die Anleitung am Ende dieser Seite.
In Faktura-XP werden die Zugangsdaten dieses neuen Benutzers und eventuell die FTP Zugangsdaten zum Server des Onlineshop eingegeben.
Schritt 1: In den Admin-Bereich des Magento-Shops einloggen
Den Admin-Bereich erreichen Sie in der Regel unter folgender Adresse: www.ihreDomain.de/admin oder www.ihreDomain.de/magento/admin, falls Ihr Shop im Unterverzeichnis "magento" installiert wurde.
Schritt 2: Zunächst muss eine Gruppenberechtigung erstellt werden
Klicken Sie dazu im Admin-Bereich auf den Menüpunkt System > Web Dienste > Gruppenberechtigungen (Pfeil).
Nachdem die Seite "Gruppenberechtigungen" geladen wurde, klicken Sie rechts auf den Knopf "Neue Rolle" (Pfeil).
Bitte geben Sie nun den Namen der Gruppen- Berechtigung ein (Pfeil rechts) und klicken Sie anschließend auf "Gruppenberechtigung Quellen" (Pfeil links).
Wählen Sie nun bei Quellenzugriff aus der Drop-Down Liste den Eintrag "Alle" aus, damit ein uneingeschränkter Zugriff zur Schnittstelle besteht.
Bitte speichern Sie anschließend die Gruppenberechtigung, indem Sie rechts oben auf den Button "Gruppenberechtigung speichern". Anschließend sollte die Meldung "Gruppenberechtigung erfolgreich gespeichert" erscheinen.
Schritt 3: Neuen Benutzer für Webdienst / Schnittstelle erstellen
Nachdem Sie nun erfolgreich eine Gruppenberechtigung erstellt haben, werden Sie jetzt den Benutzer für die Schnittstelle anlegen.
Öffnen Sie dazu wieder im Admin-Bereich den Menüpunkt System -> Web Dienste und klicken anschließend auf "Benutzer" (Pfeil).
Nachdem die Seite "Benutzer" geladen wurde, klicken Sie rechts auf den Knopf "Neuer Benutzer". Geben Sie in die darauf folgende Eingabemaske (Bild unten) Ihre gewünschten Daten für den Benutzer ein. Bitte merken Sie sich Benutzername und API Schlüssel (Passwort). Diese Angaben werden für die Eingabe in Faktura-XP benötigt um Zugriff auf Bestellungen und Artikel des Shop zu erhalten.
Verwenden Sie für Benutzernamen keinen Bindestrich, Umlaute oder Sonderzeichen.
Klicken Sie anschließend auf "Benutzer Gruppenberechtigung" (Pfeil).
Nun wählen Sie die zuvor erstellte Gruppenberechtigung aus der Liste aus (hier: gruppe1) und klicken dann auf den Button "Benutzer speichern" um Ihren Benutzer anzulegen. Jetzt ist der Schnittstellen-Zugang erfolgreich angelegt und kann mit den angegeben Daten genutzt werden.
Im nächsten Schritt werden wir die Einstellungen innerhalb Faktura-XP beschreiben.
Angaben in Faktura-XP hinterlegen
Die "Zugriffsdaten des neu angelegten Benutzers" und die "FTP Zugangsdaten" werden nun in Faktura-XP hinterlegt. Damit ist die Kommunikation zwischen Faktura-XP und dem Magento Onlineshop erst möglich. Verlassen Sie den Adminbereich des Onlineshop und starten nun die Anwendung Faktura-XP.
Klicken Sie im Menü auf "Webshop Synchronisieren".
Wählen Sie den Verbindungs-Typ "Magento" aus und klicken auf "weiter".
Lassen Sie vorerst das Häkchen "Auswahl beim nächsten mal übergehen" noch leer, bis alles nach Ihren wünschen funktioniert.
Magento Bestellverarbeitung: Registerkarte: „Bestellabruf”
Wenn Sie Ihre Auswahl getroffen haben, gelangen Sie in die Magento Bestellverarbeitung.
Zunächst müssen wir die Zugangsdaten in Faktura-XP hinterlegen. Dazu wechseln Sie auf die Registerkarte "Einstellungen". (Um mehr über den Bestellabruf zu erfahren besuchen SIe die Seite Abruf von Bestellungen aus Magento)
Magento Bestellverarbeitung: Registerkarte: „Einstellungen”
Zugriffsprofile
Klicken Sie hier auf die Schaltfläche "Zugriffsprofile und User-Zugang". Es öffnet sich der separate Dialog zur Verwaltung der Zugriffsprofile.
Profile und Einstellungen für den Datenzugriff: Registerkarte „Zugriffsprofile”
Zugangsdaten zum Datenabruf konfigurieren
Die Zugangsdaten werden in so genannten Profilen gespeichert. Ein Profil umfasst zwei Zugangsdaten. Zum einen sind dies die "FTP-Zugangsdaten" die einen Zugriff auf Ihren Server-Account bei Ihrem Provider zulassen und zum anderen die Zugangsdaten des Benutzers für Webdienste Ihres Magento-Shop. Die Anlage dieses Benutzers haben wir oben beschrieben.
Sie können beliebig viele Profile anlegen und verwenden. Für die Neuanlage eines Profils klicken Sie auf die Schaltfläche "+" und geeben dem Profil zunächst einen eindeutigen Namen.
Server Zugriff konfigurieren
Geben Sie dann im Bereich "Server Zugriff" des Dialogs die FTP Zugangsdaten zu Ihrem Server ein. Verwenden Sie im Feld "FTP-Server" die Domain- oder IP-Adresse des Servers Ihres Shop. Bei "FTP Username" und "FTP Passwort" geben sie exakt die Daten von Hand ein, die Sie von Ihrem Provider erhalten haben. Achten Sie dabei auf Groß- und Kleinschreibung.
Befindet sich Ihr Shop in einem Unterverzeichnis "http://www.MeinShop.de/verzeichnis1/verzeichnis2/" geben Sie im Feld "Verzeichnis" das/die Unterverzeichnisse mit ein z.B. "/verzeichnis1/verzeichnis2/" (ohne Anführungszeichen).
Magento Zugriff konfigurieren
Für den Datenabruf müssen Sie noch die Zugangsdaten des zuvor angelegten Benutzers für Web Dienste (siehe [Anhang_13_(Magentocommerce)|oben]]) eingeben.
Geben Sie im Feld "Domainname Shop" die komplette Internetadresse, inkl. eventueller Unterverzeichnisse ein - z.B. "www.MeinShop.de/verzeichnis1/verzeichnis2/" (ohne Anführungszeichen).
Im Feld "Benutzernamen" und "API-Schlüssel" geben Sie die Zugangsdaten des zuvor angelegten Benutzer des Magento-Shop ein und setzen das Häkchen "Zugangsdaten lokal speichern" um die Daten auf Ihrem PC zu speichern.
"Benutzernamen" und "API-Schlüssel" sind NICHT die Zugangsdaten zum Adminbereich Ihres Shop!!!
Mit der Schaltfläche "OK" oder der Schaltfläche "Diskette" wird das Profil lokal abgespeichert. Ein Profil löschen können Sie mit der Schaltfläche "X" neben dem Profilnamen.
FTP Upload der Schnittstelle und die "Testen" - Taste
Mit der Schaltfläche "Testen" wird über das eingegebene Profil eine FTP-Verbindung zum Webserver hergestellt. Nun prüft Faktura-XP, ob auf dem angegebenen Server und dem eingegebenen Verzeichnis ein Magento®-Shop vorhanden ist. Dies stellt Faktura-XP fest indem das Vorhandensein der Datei "../app/Mage.php" auf dem Webserver geprüft wird.
War die Prüfung erfolgreich werden die zur Kommunikation nötigen Dateien auf den Webserver geladen, falls diese dort noch nicht vorliegen. Diese Dateien befinden sich im Verzeichnis "..\system\apicon\" Ihrer lokalen Faktura-XP Installation und werden auf den Webserver in das Hauptverzeichnis (Root) des Shops transferiert.
Sollte ein Transfer - z.B. wegen eines Schreibschutzes auf dem Server nicht möglich sein, können Sie das Verzeichnis auch mit Ihrem FTP-Programm direkt auf den Server laden. Dazu laden Sie das verzeichnis "apicon" in die Hauptebene Ihres Webshop. Das Verzeichnis "Apicon" finden Sie im Unterverzeichnis "System" Ihrer Faktura-XP Installation.
Das Verzeichnis "apicon" muss sich auf der gleichen Ebene befinden wie das Verzeichnis "app" Ihres Magento®-Shop.
Hinweis: Nun ist die Schnittstelle eingerichtet und für die Kommunikation mit Ihrem Onlineshop bereit.
Weitere Konfigurationsmöglichkeiten:
Profile und Einstellungen für den Datenzugriff: Registerkarte: „Optionen”
Hier finden Sie das FTP Transfer Parameter. Die Einstellungen für die Transfer-Art und den Verbindungsmodus besitzen im Vorraus die Standard Konfiguration. Falls Sie lieber die Transfer-Art auf Binär oder ASCII umstellen möchten, dann wählen Sie die entsprechende Einstellung aus. Bei dem Verbindungsmodus, wählen Sie zwischen dem passiven und dem aktiven Modus.
Parameter
In das Parameter gelangen Sie, indem Sie in dem Register „Einstellungen” auf den Button 
klicken. Nun öffnet sich ein neues Fenster mit weiteren Registerkarten.
Registerkarte: Shop
In dem Bereich unter Mehrwertsteuer können Sie entsprechende Einstellungen vornehmen, wie z.B ob Faktura-XP die Versandkosten in Brutto (inkl.MwSt) berechnet oder wie hoch die MwSt für den Versand ist. Links in den zwei Feldern sehen Sie oben Ihren Standort und darunter Ihre aktuelle Standardwährung.
Registerkarte: weitere Parameter
Unter weitere Parameter können Sie verschiedene Einstellungen über den Kundenstamm, Zahlungsbedingungen, Versandkosten-Bindung, Bank-Transfer, DTA Erzeugen und Bestellnummern vornehmen.
Registerkarte: Artikelübertragung
Hier konfigurieren Sie die Einstellungen zu der Artikelübertragung, den Artikelpreisen und der Erlöse und Einheit.
Registerkarte: Löschfunktionen
Unter Löschfunktionen können Sie Shopartikel oder Shop-Kategorieren löschen. Achten Sie hierbei auf die Hinweise.
Magento Bestellverarbeitung: Registerkarte: Protokoll
Je nach Abruf listet Faktura hier die entsprechenden Daten auf. Wenn Sie über ein anderes Register einen Abruf tätigen, wechselt Faktura in dieses Register um Ihnen die Daten aufzuzählen. Mehr dazu finden Sie auf der Seite Abruf von Bestellungen aus Magento
Magento Bestellverarbeitung: Registerkarte: „weitere Funktionen”
In dem Register „weitere Funktionen”, können Sie Abrufe tätigen oder Konfigurieren. Zudem erhalten Sie Informationen zu Ihren Storeviews und können Adressen und Lagerartikel aktualisieren.
Klicken Sie auf Kundenabrufe, zeigt Faktura Ihnen in einem kleinen Fenster die Gesamtanzahl von Kunden und die Anzahl der Neukunden an.
Wenn Sie Ihre Artikel abrufen, sichert Faktura erst die Daten und zeigt dann die Ergebnisse im Protokoll an, welches direkt aufgeschlagen wird.
Klicken Sie auf diese Schaltfläche, aktualisiert Faktura Ihre gespeicherten Adressen.
Bei Betätigung aktualisiert Faktura-XP die Lagerbestände in Ihrem Onlineshop, berücksichtigt dabei aber auch die Lagerentnahme im Onlineshop, die z.B durch Bestellungen von Kunden erfolgt.
Um Ihre Shop-Artikel zu aktualisieren, klicken Sie auf diese Schaltfläche. Es öffnet sich nun ein neues Fenster mit verschiedenen kriterien für den Artikelimport.
Hier können Sie z.B Auswählen ob Sie die Artikelbeschreibungen Ihrer Artikel in Faktura-XP mit denen in Ihrem Onlineshop abgleichen oder die Verkaufpreise aktualisieren wollen. Sie können auch mehrere Kriterien aufeinmal auswählen.
Hinweis: Wenn Faktura den Artikel oder Kundenabruf nicht vollständig ausführen konnte, (z.B durch eine Unterbechung der Verbindung oder ähnliches) kann durch ein gesetzes Häkchen im Feld für „Abruf mit lokalen Daten,” Faktura den unterbrochenen Abruf fortsetzen. Sie setzen also das Häkchen und führen den Abruf erneut aus. Somit wird dieser fortgesetzt und nicht erneut vollständig verarbeitet.
Storeviews
Was sind Storeviews?
Storeviews beschreiben jeden einzelnen Shop durch verschiedene Interfaces im Magento. Ist z.B. ein deutscher und ein englischer Shop vorhanden, so sind zwei Storeviews gegeben. Storeviews können beliebig oft verwendet und individuell gestaltet werden.
Klicken Sie auf die Schaltfläche 
, wird eine Liste der Storeviews online abgerufen und die lokalen Storeviews aktualisiert. Diese werden dann in der Liste sichtbar, aber auch wenn Sie andere Funktionen nutzen.
Haben Sie mehrere Stores, können Sie oben rechts im Register unter Abruf den jeweiligen Store aussuchen. Die Zahl 0 steht für alle Stores und somit werden alle Übertragungen, Aktualisierungen usw. bei allen Stores vorgenommen.
Im unteren Teil des Registers, haben Sie die Möglichkeit den Beginn des jeweiligen Abrufes selbst festzulegen oder nur zu kontrollieren. Der Abruf wird ab der eingestellten Bestellnummer fortgeführt. Den letzten zeigt Ihnen Faktura im oberen Feld an. In dem unteren Feld können Sie diese Nummer selbst festlegen, jedoch wird damit der Wert der automatischen Erkennung von Faktura überschrieben.
Error-Codes und Funktionsstörungen
Die Error-Codes (Fehler-Codes)
Wenn eine Überprüfung der Verbindung mit dem Magento-Shop nicht möglich ist (Betätigen der Taste „Testen”), zeigt Faktura Ihnen Fehlermeldungen an. Solche Error-Codes (Fehler-Codes) enthalten den Grund und die zugehörige Zahl der jeweiligen Fehlermeldung.
Bedeutungen der Error-Codes/ Fehlermeldungen:
Fehlermeldungen beim Login:
/* Login */
define 100; --> Diese Meldung wird angezeigt, wenn kein Fehler beim Login aufgetreten ist (Nummer 100) define 101; --> Der Zugang zum Shop wird verwehrt (Nummer 101) define 199; --> Ein noch unbekannter Fehler ist aufgetreten (Nummer 199)
Fehlermeldungen beim Skript:
/* Skript */
define 1000; --> Faktura konnte keinen Skript finden (Nummer 1000) define 1099; --> Dieser Fehler tritt auf, wenn Sie versuchen Sich einzuloggen, aber bereits eingeloggt sind (Nummer 1099) define 1110; --> Es entsteht ein Fehler beim Lesen des Produktes (Nummer 1110) define 1210; --> Ein benötigter Ordner ist nicht vorhanden (Nummer 1210) define 1310; --> Ein gesuchter Kunde fehlt (Nummer 1310) define 1410; --> Die Addressen-Angabe existiert nicht (Nummer 1410) define 1510; --> Die gesuchte Kategorie konnte nicht gefunden werden (Nummer 1510)
Funktionsstörungen oder Test klappt nicht
Sollte es zu Problemen mit dem hochladen der Schnittstellen Scripte ("apicon" Ordner) geben, prüfen Sie mit einem FTP Programm ob das Verzeichnis "apicon" am angegebenen Ort des Webserver vorhanden ist. Danach prüfen Sie, ob alle Unterverzeichnisse und Dateien in diesem Ordner enthalten sind. Ist dies auch der Fall, prüfen Sie zuletzt noch ob diese Unterverzeichnisse die eigentlichen Scripte enthalten. Dies sind Dateien mit der Endung ".php".
Sollten alle Scripte vorhanden sein und Probleme auftreten können Sie sich auch gern an unsere Hotline wenden oder eine Email an unseren Support [1] senden.
Support Mailadresse: support@faktura-xp.de
.
