Core API

Aus ShopleiterWiki

1.2.6 Core API von Magento

Neben den vielen bereits im Shop integrierten Schnittstellen gibt es neben der Import-bzw. Export-Möglichkeit noch die Magento Core API. Der wesentliche Vorteil der API gegenüber dem Import/Export ist: die Daten sind sofort in Echtzeit verfügbar und nicht erst nach dem Durchlauf eines Cron-Jobs, der zu einer bestimmten Uhrzeit läuft. Mit dieser Application Programming Interface (API) sind Sie in der Lage, zusätzlich benötigte Schnittstellen und Anbindungen an Drittsysteme selber zu programmieren. Aktuell unterstützt die Core API sowohl das SOAP- als auch XML-RPC-Protokoll.

SOAP (Simple Object Access Protocol) ist ein Protokoll, mit dessen Hilfe Sie Daten austauschen und Remote Procedure Calls durchführen. Es stützt sich unter Anderem auf XML zur Repräsentation der Daten. WSDL (Web Service Description Language) ist ebenso eine plattformunabhängige Beschreibungssprache für Netzwerkdienste (Web Services) zum Nachrichten-Austausch auf Basis von XML. Wollen Sie auf die Magento Web Services zugreifen, dann verwenden Sie folgende Zugriffsadressen:

WSDL Aufruf: /api/?wsdl oder /api/soap/?wsdl
XML-RPC Aufruf: /api/xmlrpc/

Leider läuft die Schnittstelle momentan noch nicht so performant, wie sich viele Entwickler das wünschen. Die Führungsriege hat aber auf dem Meet Magento Treffen versprochen, sich bevorzugt um dieses Manko zu kümmern. Die Schnittstelle erlaubt den Datenzugriff auf die ausgelesenen Daten nur denjenigem, der die nötigen Rechte besitzt. Dafür legen Sie im Backend eigene Benutzer (User) und Rollen (Role) an. Dann ist es möglich, Daten von Kunden, Artikeln oder Bestellungen auszulesen. Alle API Aufrufe (calls) finden Sie in Tabelle 1.6.

Core API calls
Customer API
Customer's Groups API
Customer Address API
Country API
Region API
Category API
Category attributes API
Product API
Product attributes API
Product attribute sets API
Product types API
Product Images API
Product Tier Price API
Product links API
Order API
Shipment API
Invoice API
Inventory API

Tabelle 1.6: Alle vorhandenen Core API Aufrufe in Magento

Auf der Homepage finden Sie eine ziemlich ausführliche Dokumentation. Alle API’s enthalten ausführliche Beispiele, mit denen Sie sofort die Funktionalität testen können.

Dokumentation der Magento Core API

Einen API-Zugriff erstellen Sie mit wenigen Schritten:

Legen Sie eine neue Rolle mit Gruppenberechtigungen an!
Konfigurieren Sie einen Benutzer der Zugriff auf die Rolle erhält!
Erstellen Sie eine PHP-Datei mit den nötigen Methoden zur Datenabfrage!

Bevor Sie einen API-Zugriff vornehmen können, benötigen Sie einen Benutzer, den Sie einer Rolle mit bestimmten Rechten (permissions) zuordnen. Im ersten Schritt erstellen Sie zunächst eine Rolle mit den gewünschten Gruppenberechtigungen. Öffnen Sie dazu die Gruppenberechtigungen (Roles) im Menüpfad „System › Web Services“ (System › Web Services). In Abhängigkeit davon, welche Kästchen Sie abhaken, darf die erstellte Rolle auf die jeweiligen Daten zugreifen. Je weniger Sie anhaken, desto geringer sind die Berechtigungen.

Abb. 1.12: Gruppenberechtigungen für eine neue Rolle festlegen

Im zweiten Schritt erstellen Sie einen Benutzer, der das Recht bekommt, auf die neue Rolle zuzugreifen. Für einen neuen Benutzer benötigen Sie einen API Schlüssel (API Key), was im Endeffekt nichts anderes als ein Kennwort ist. Vergessen Sie nicht, das Benutzerkonto auf aktiv zu setzen, sonst ist der Benutzer nicht verwendbar. Vor dem Abspeichern weisen Sie diesem Benutzer noch die gewünschte Rolle zu.

Jetzt können Sie beispielsweise das Auslesen der Bestelldaten starten, indem Sie eine einfache PHP-Datei anlegen. Als mögliche Methoden sind bei der Order API (sales_order) folgende Methoden möglich:

sales_order.list – Hole eine gefilterte Liste mit Bestellungen
sales_order.info – Hole die Bestell-Informationen
sales_order.addComment – Füge Kommentar zur Bestellung hinzu
sales_order.hold – Zwischenspeichern einer Bestellung
sales_order.unhold – Verwerfen einer Bestellung
sales_order.cancel – Abbrechen einer Bestellung

Order API der Ressource sales_order

Die Order API speichert in Listing 1.9 alle Bestell-Informationen zur Bestell-Nr. 1000016 in der Variable $order. Die Daten werden in diesem Fall aus Daten-Array gespeichert. Für einen ersten Test reicht die Ausgabe mittels print_r völlig aus, etwas besser lesbar ist die zweite Darstellung mit der foreach-Schleife. Sollen die Daten gezielt ausgelesen werden sind ein paar Grundkenntnisse in PHP sehr hilfreich.

<?php
  // Variablen festlegen
  $user = "bestellinformationen";  // API-User
  $key  = "2739919jtl11";          // API-Schlüssel
  $orderID = "1000016";            // Bestellnummer
  // Datenzugriff starten
  $proxy = new SoapClient("http://www.domain.de/shop/api/?wsdl");
  $sessionId = $proxy->login($user, $key);
  // Bestell-Informationen holen (Bestell-Nr. 1000016)
  $order=$proxy->call($sessionId, "sales_order.info", $orderID);
  // Bestell-Informationen als Array ausgeben
  print_r($order);
  // Bestell-Informationen zeilenweise ausgeben
  foreach($bestellung as $name => $wert) {
     echo $name." = ".$wert."<br />";
  }
?>

Listing 1.9: PHP-Datei zum Zugriff auf Bestellinformationen

Natürlich dürfen Sie die PHP-Datei so nicht in einen produktiv betriebenen Shop hochladen, da sonst jeder auf Ihre Daten zugreifen kann, der den Pfad zur Datei kennt. Das obige Beispiel dient rein zu Demonstrationszwecken. Den Datenzugriff müssen Sie daher unbedingt mit geeigneten Mitteln absichern. Bleibt die Seite weiß, liegt es in den allermeisten Fällen entweder an den falschen Zugriffsdaten für den API-Benutzer oder den API-Schlüssel bzw. an den fehlenden Rechten der neuen Rolle.

Ein weiteres praktisches Beispiel zur API-Schnittstelle finden Sie in Kapitel 4, in dem es um die Bestellübergabe an ein Warenwirtschaftssystem geht.[[Ka $wert) {

    echo $name." = ".$wert."
";
 }