Schnittstellenarchitektur:

Transportmethode:

Die XML Calls werden mit Hilfe des HTTP Protokolls an die Zieldomain (die des Shops) übertragen.
Dazu wird mit dem HTTP Request vermittels der POST Methode auf die Zieladresse ein Parameter mit dem Namen xml übergeben der die jeweiligen Daten enthält.

Zeichensatz:

Grundsätzlich wird der UTF-8 Zeichensatz verwendet.

Authentifikation:

Um den API Benutzer sicher zu authentifizieren muss dieser zunächst im XML API Tool des Shopsystems angelegt werden. Die Zugangsdaten bestehen aus dem Benutzernamen und dem Passwort sowie dem API Key.
Damit der Benutzer authentifiziert werden kann müssen diese Daten im Call mitgesendet werden. Dies sollte aus Sicherheitsgründen niemals im Klartext geschehen daher werden grundsätzlich Hashwerte (MD5) statt Klartextangaben verwendet. Somit müssen die Zugangsdaten auch bei der aufrufenden Plattform niemals im Klartext vorliegen.

Bitte beachten, jeder Zugriff muss die Authentifikationsdaten mitsenden!

Beispiel:

<?xml version=”1.0″ encoding=”UTF-8″ standalone=”yes”?>
<call>
<authentification>
<user>5d9c68c6c50ed3d02a2fcf54f63993b6</user>
<pass>179ad45c6ce2cb97cf1029e212046e81</pass>
<api_key>e26b518c6bfe6f605acc211201071bad</api_key>
</authentification>
</call>

Kommandoübergabe:

Damit das API weiß was es tun soll muss ein gültiges Kommando übertragen werden. Daher wird jedem Call ein entsprechender Parameter mitgegeben.
Bitte beachten, jeder Zugriff muss ein Kommando mitsenden!

Beispiel:

<?xml version=”1.0″ encoding=”UTF-8″ standalone=”yes”?>
<call>
<action>get_api_data</action>
</call>
Beispielcall:

Da die beiden obigen Angaben mitgegeben werden müssen ergibt sich ein Mindestschema für einen korrekten Call an das API.

Beispiel:

<?xml version=”1.0″ encoding=”UTF-8″ standalone=”yes”?>
<call>
<authentification>
<user>5d9c68c6c50ed3d02a2fcf54f63993b6</user>
<pass>179ad45c6ce2cb97cf1029e212046e81</pass>
<api_key>e26b518c6bfe6f605acc211201071bad</api_key>
</authentification>
<action>get_api_data</action>
</call>

Dieser Call würde (korrekte Zugangsdaten vorausgesetzt) die Version des XML API zurückgeben.

Rückgabewerte:

Nachdem die Eingaben überprüft und der Benutzer authentifiziert wurde stellt das API die angeforderten Daten gemäß des übergebenen Kommandos zusammen und gibt diese als XML Dokument zurück.
Sollten die Eingaben nicht korrekt sein wird eine entsprechende Fehlermeldung zurückgegeben.

Beispiel:

Es wurde kein Kommando übergeben:

<?xml version=”1.0″ encoding=”UTF-8″ standalone=”yes”?>
<document>
<result>
<error>no action given</error>
</result>
</document>

Der Inhalt des Tags error ermöglicht ein genaues Debugging.
Sollte der Call korrekt sein wird die angeforderte Information zurückgegeben.

Beispiel:

Es wurde die API Version angefordert:

<?xml version=’1.0′ encoding=’UTF-8′ standalone=’yes’?>
<document>
<result>
<api_name>my-Warehouse XML API</api_name>
<api_version>v 0.2 beta</api_version>
<api_date>2010-01-10</api_date>
</result>
</document>

Bei Calls die eine Parameterübergabe erfordern wird der Wert unterhalb des Kommandos mitgesendet.

Beispiel:

<?xml version=”1.0″ encoding=”UTF-8″ standalone=”yes”?>
<call>
<authentification>
<user>5d9c68c6c50ed3d02a2fcf54f63993b6</user>
<pass>179ad45c6ce2cb97cf1029e212046e81</pass>
<api_key>e26b518c6bfe6f605acc211201071bad</api_key>
</authentification>
<action>get_customers_main_data_by_id</action>
<customers_id>1</customers_id>
</call>

Sandbox:

Sollten Sie ein Produkt auf Basis der XML API erstellen wollen setzen Sie sich bitte mit uns in Verbindung. Gern stellen wir Ihnen einen Sandboxshop zur Verfügung um die Schnittstellenfunktionalität zu testen.

Calls:

Die Anzahl der Calls wird von der STAPIS GmbH permanent erweitert und den Bedürfnissen der Shopbetreiber bzw. denen der angeschlossenen Drittplattformen angepasst. Anregungen sind jederzeit willkommen.