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.

Allgemeines :

Begriffserklärung:

Das XML API stellt eine Schnittstelle zum Shopsystem zur Verfügung die über das XML Protokoll vermittels des HTTP Transportprotokolls angesprochen werden kann. Die Schnittstelle stellt genau definierte Kommandos, sogenannte Calls, zur Verfügung mit deren Hilfe Daten aus dem System ausgelesen, verändert oder neu angelegt werden können.

Nutzen:

Über die Schnittstelle können angeschlossene Softwareprodukte Daten aus dem Shopsystem beziehen und diese gemäß der eigenen Funktionalität weiterverarbeiten. So können über die Schnittstelle beispielsweise externe Newsletterdienste, ERP oder CRM Systeme und einiges mehr elegant angebunden werden.
Es gibt aber auch den Weg das die aufrufende Software Daten in das Shopsystem schreibt, das wäre beispielsweise bei Warenwirtschaftssystemen durchaus sinnvoll.
Das API ermöglicht es so externen Anbietern Ihre bereits vorhandene Software an das my-Warehouse Shopsystem anzubinden oder neue Software für das Shopsystem zu erstellen und diese als externen Dienst anzubieten.
Da die Dokumentation der Schnittstelle frei zur Verfügung steht können fast beliebige Anbindungen geschaffen werden.

Sicherheit:

Wie bei allen bidirektionalen Schnittstellen ist auch hier das Missbrauchspotential groß, daher muss der Zugang zum API auf authorisierte Personen / Parteien beschränkt bleiben. Um dies abzusichern müssen Benutzer der Schnittstelle vorher als solche angelegt werden und Zugangsdaten sowie einen API Key bekommen die eine eindeutige Authentifikation sicherstellen.
Bei allen Zugriffen müssen diese Authentifizierungsdaten gesendet werden, zur Sicherheit geschieht dies niemals im Klartext. Shops die über ein eigenes SSL Zertifikat verfügen können die Kommunikation über das SSL Zertifikat verschlüsseln und solchermaßen zusätzlich absichern.
Die Benutzung der Schnittstelle erfolgt auf eigene Gefahr!

Zertifizierung:

Sie haben eine Anwendung mit Anbindung an das my-Warehouse XML API erstellt und möchten diese nun von uns zertifizieren lassen?

Kein Problem, bitte wenden Sie sich unter der unten angegeben Adresse an uns, gern testen wir Ihre Anwendung der Test ist selbstverständlich kostenlos.

Zertifizierte Anwendungen bekommen unser Schnittstellensiegel als „zertifizierte Anwendung“, ein eigenes Anwendungsprofil im Administrationsbereich und können in unser Anwendungsverzeichnis aufgenommen werden.

Weiterentwicklung:

Schnittstellen müssen alle möglichen Anwendungsfälle abbilden können, daher werden Sie gewöhnlich kontinuierlich weiterentwickelt. So ist es auch mit diesem API, sollten Sie Anregungen, Lob oder Tadel haben wenden Sie sich bitte direkt an uns.

Ab sofort überprüft das erweiterte Universal Shop Check Tool weitere Einstellungen des Onlineshops.

So werden zahlreiche weitere Grundeinstellungen sowie die neuen Newslettereinstellungen überprüft und gegebenenfalls Hinweise auf Verbesserungen gegeben.

Der Universal Shop Check ist in allen my-Warehouse Shoppaketen bereits enthalten.

my-Warehouse Shopbetreiber haben viele Möglichkeiten Ihren Shop individuell zu gestalten.

Hier zeigen wir Ihnen wie Sie die Produktliste in einer Kategorie gestalten können.

Zunächst gibt es im Backend dafür ein Tool in dem die Einstellungen für die Anzeige präsentiert werden.

Dort können Sie verschiedene Funktionen ein- oder ausschalten. Sie können dies alles gestalten, Programmierkenntnisse sind nicht notwendig.

Einstellungen der Kategorienansicht im Administrationsbereich

Beispielsweise können Sie aus 4 verschiedenen Grundlayouts auswählen.

klassische Listenansicht

einfache Blockansicht

zweifache Blockansicht

dreifache Blockansicht

Sie können aber auch einzelne Elemente in der Trefferanzeige gezielt aktivieren oder deaktivieren, ebenso ist es möglich einen Herstellerfilter einzublenden oder die Leiste mit der Anzeige der Anzahl der Produkte und ggfls. den weiterführenden Elementen oben, unten oder an beiden Stellen zu positionieren.

2er Blockansicht mit Funktionsleiste oben

2er Blockansicht mit Funktionsleiste unten

zweifache Blockansicht mit Funktionsleiste oben und unten

All das arbeitet völlig unabhängig vom gewählten Template, ist jederzeit ganz leicht veränderbar und ermöglicht es dem Shopbetreiber weitgehend in die Gestaltung einzugreifen.