Magento Training und Beratung

Weil man im Web zu wenige Beispiele für Roh-Abfragen für die SOAP API v2 findet, hier ein paar Beispiele. Diese Abfragen können mit dem kostenfreien GUI-Tool Insomnia ausprobiert werden:

Auf der Kommandozeile lässt sich der Aufruf wie folgt umsetzen:

curl -id "requestBody.xml" https://xonu.de/index.php/api/v2_soap

Abfrage der Schnittstellenbeschreibung im WSDL-Format:

https://xonu.de/api/v2_soap/?wsdl=1

Alle GET-Anfragen werden an die folgende URL gesendet:

https://xonu.de/api/v2_soap

Request Body für Login:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <MAGE:login xmlns:MAGE="https://gaiwan.de/api/v2_soap/?wsdl=1">
        	<MAGE:username>API-USER</MAGE:username>
        	<MAGE:apiKey>API-KEY</MAGE:apiKey>
        </MAGE:login>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response Body mit sessionId für weitere Abfragen:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns1="urn:Magento"
	xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
	<SOAP-ENV:Body>
		<ns1:loginResponse>
			<loginReturn xsi:type="xsd:string">SESSION-ID</loginReturn>
		</ns1:loginResponse>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Einfacher Filter für zurückgestellte Bestellungen (status = holded):

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:Magento" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:salesOrderList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <sessionId>SESSION-ID</sessionId>
            <filters>
                <filter>
                    <associativeEntity>
                        <key>status</key>
                        <value>holded</value>
                    </associativeEntity>
                </filter>
            </filters>
		 </urn:salesOrderList>
   </soapenv:Body>
</soapenv:Envelope>

Komplexer Filter für Bestellungen, die in August 2022 aktualisiert wurden und status = complete (Operatoren: eq – equal, lt – lower then, qt – greater then) haben:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:Magento" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
	<urn:salesOrderList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
	<sessionId>SESSION-ID</sessionId>
		<filters>
			<complex_filter>
				<filter>
					<key>Updated_at</key>
					<value>
						<key>gt</key>
						<value>2021-08-01 00:00:00</value>
					</value>
				</filter>
				<filter>
					<key>updated_at</key>
					<value>
						<key>lt</key>
						<value>2022-08-31 23:59:59</value>
					</value>
				</filter>
				<filter>
					<key>status</key>
					<value>
						<key>eq</key>
						<value>complete</value>
					</value>
				</filter>
			</complex_filter>
		</filters>
	</urn:salesOrderList>
</soapenv:Body>
</soapenv:Envelope>

Zum Schluss noch ein Beispiel zum Laden einer konkreten Bestellung über die incrementId = 100012345:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:Magento" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
 <soapenv:Header/>
   <soapenv:Body>
      <urn:salesOrderInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <sessionId>SESSION-ID</sessionId>
         <orderIncrementId>100012345</orderIncrementId>
      </urn:salesOrderInfo>
   </soapenv:Body>
</soapenv:Envelope>

Der Support für Magento 1.x endete offiziell am 30.06.2020. Leider hat Adobe sich scheinbar entschieden alle Brücken zu Magento 1.x zu verbrennen und hat nicht nur die Online-Dokumentation sondern sogar die Repository auf GitHub gelöscht.

Gut, dass die Magento-Community groß und engagiert ist, sodass man die Online-Dokumentation hier weiterhin abrufen kann:

• https://r-martins.github.io/m1docs/guides/m1x/
• https://devdocs-openmage.org/guides/m1x/

Die letzte offizielle Magento 1.x Version kannst du hier herunterladen:
Magento 1.9.4.5, Release: 04.05.2020

https://mage-one.com bietet unbegrenzten Support für Magento 1.x weiterhin an. Eine weitere Alternative ist der Fork https://www.openmage.org/ auf Basis von Magento 1.x.

Bool’sche Algebra ist in der Programmierung nicht mehr wegzudenken. Heute feiert Google den 200. Geburtstag von George Boole, der die Bool’sche Algebra erfunden hat.

Während im Alltag uns die mathematischen Operationen wie Addition und Multiplikation eher begegnen, sind boolsche Operationen in der Programmierwelt der Alltag. Google demonstriert die Rechenergebnisse von vier Operatoren: AND, OR, XOR, NOT. Ähnlich wie 2 +3 = 5 ist, ist 1 OR 0 = 1. Bool’sche Operatoren rechnen mit binären Zahlen 1 (wahr, engl. true) und 0 (falsch, engl. false). Das Ergebnis einer Bool’schen Operation ist ebenfalls eine binäre Zahl.

Der Buchstabe g im Logo zeigt die Eingabe, die bestimmt, welche anderen Buchstaben leuchten (d. h. mit Farbe gefüllt werden). Ein leuchtender Buchstabe entspricht der binären 1 oder dem logischen Wert Wahr, während ein grauer Buchstabe der 0 entspricht, oder dem logischen Wert Falsch. Wird der x bzw. y eingeblendet, so ist x bzw. y wahr, d. h. gleich 1. Wird x bzw. y ausgeblendet, so ist x bzw. y falsch oder gleich 0. Die Animation des Logos wechselt die vier Kombinationen von x und y ab und zeigt in den anderen Buchstaben die Ergebnisse des jeweiligen Operators.

Intuitive Erklärung der Operatoren:

• AND: Beides muss wahr sein, x und y müssen beide wahr sein.
• OR: Mindestens eins von beiden x oder y muss wahr sein.
• XOR: Genau eins x oder y muss wahr sein, aber nicht beide x und y.
• NOT: Der umgekehrte Wert, die Negation, nicht wahr ist falsch, nicht 0 ist 1.

Die nachfolgende Wahrheitstabelle fasst alle vier Kombinationen zusammen:

Auf der Seite mit Suchergebnissen ist die Animation nicht mehr zu sehen. Dort setzt Google das Thema mit dem &-Zeichen vor dem Buchstaben g fort:

Weiterlesen:

• Offizielle Doodle-Seite zum 200. Geburtstag von George Boole
• Wahrheitstabelle oder Wahrheitstafel (Wikipedia)

Layout XML kann im Backend von Magento in Kategorien, Produkten und CMS-Seiten verwendet werden. XML-Code wird jeweils in das Feld Custom Layout Update im Register Design eingegeben. Das eingegebene Layout-XML-Code gilt dann für das bearbeitete Produkt, die Kategorie oder die CMS-Seite.

Zum Bearbeiten des globalen Layouts sollte in Magento die eigene local.xml im Layout-Verzeichnis app/design/frontend/default/mytheme des aktuellen Themes mytheme angelegt und bearbeitet werden. Alle Befehle müssen sich innerhalb des Knotens layout befinden:

<?xml version="1.0"?>
<layout version="0.1.0">

    ...

</layout>

Im Backend der der Layout-XML-Code ohne diesen Knoten verwendet.

In app/design/frontend/base/default/layout/page.xml ist der Block mit dem Namen head definiert und gibt die Inhalte des HTML-Bereichs <head> aus. Mit der Block-Methode addItem() kann diesem Bereich ein JavaScript oder CSS hinzugefügt werden. Die Methode erwartet zwei Parameter: Pfad-Typ und den Dateinamen relativ zum Pfad-Typ.

Vordefinierte Pfad-Typen:

• js: js/*.js
• skin_js: skin/*/*.js
• js_css: js/*.css
• skin_css: skin/*/*.css

Quelle: Mage_Page_Block_Html_Head::getCssJsHtml()

Es sind noch weitere Alias-Methoden definiert, die jeweils addItem() mit einem bestimmten Pfad-Typ aufrufen. Folgende Alias-Methoden sind in Mage_Page_Block_Html_Head vorhanden:

• addCss: ruft addItem mit dem type=skin_css
• addJs: ruft addItem mit dem type=js
• addCssIe: ruft addItem mit dem type=skin_css und dem parameter IE
• addJsIe: ruft addItem mit dem type=js und dem parameter IE

Die local.xml, die dem HTML-Bereich <head> custom.css aus dem Verzeichnis skin/frontend/default/mytheme/css hinzufügt, würde wie folgt aussehen:

<?xml version="1.0"?>
<layout version="0.1.0">

    <default>

        <reference name="head">
            <action method="addItem">
                <param1>skin_css</param1>
                <param2>css/custom.css</param2>
            </action>
        </reference>

    </default>

</layout>

Alternativ kann die Alias-Methode addCss verwendet werden:

<?xml version="1.0"?>
<layout version="0.1.0">

    <default>

        <reference name="head">
            <action method="addCss">
                <param1>css/custom.css</param1>
            </action>
        </reference>

    </default>

</layout>

Die beiden Layout-XML-Codes führen zum gleichen Ergebnis; Sie fügen dem HTML-Bereich <head> auf allen von Magento generierten Seiten die folgende Zeile hinzu:

<head>
...
   <link rel="stylesheet" type="text/css" href="http://domain.tld/skin/frontend/default/mytheme/css/custom.css" media="all" />
...
</head>

Die Alias-Methode addCssIe würde diese Zeilen erzeugen:

<head>
...
<!--[if IE]>
<link rel="stylesheet" type="text/css" href="http://domain.tld/skin/frontend/default/mytheme/css/custom.css" media="all" />
<![endif]-->
...
</head>

Layout-Handles definieren den Kontext, in dem die Layout-Befehle gelten sollen. Das in den Beispielen verwendete Layout-Handle default bezieht sich auf alle Seiten. Neben diesem werden die folgende Handles bei Magento mit zusätzlichem Layout-Code erweitert:

• catalog_product_view – Alle Produkt-Detailseiten
• catalog_category_default – Alle Kategorien
• catalog_category_layered – Alle Ankerkategorien
• cms_index_defaultindex – Startseite

Mit dem folgenden Layout-XML-Code kann allen Produkt-Detailseiten ein JavaScript aus dem Skin-Verzeichnis des aktuellen Themes mytheme hinzugefügt werden:

<?xml version="1.0"?>
<layout version="0.1.0">

    <catalog_product_view>

        <reference name="head">
            <action method="addItem">
                <param1>skin_js</param1>
                <param2>js/custom.js</param2>
            </action>
        </reference>

    </catalog_product_view>

</layout>

Das Ergebnis wäre die folgende Zeile im HTML-Bereich <head> auf jeder Produktseite:

<head>
...
   <link rel="stylesheet" type="text/css" href="http://domain.tld/skin/frontend/default/mytheme/js/custom.js" media="all" />
...
</head>