Calls | my-Warehouse Blog - das Neueste rund um e-Commerce mit dem my-Warehouse Shopsystem!

19. Januar 2010

my-Warehouse XML API - eine Einführung in die XML Schnittstelle des my-Warehouse Shopsystems Teil 3/3

Abgelegt unter: Allgemein, Tips'n'Tricks | — Tags:API, API Call, API Calls, Calls, get_api_data, get_connected_domains, get_currencies_list, get_currently_running_action, get_current_customer_groups_list, get_current_languages_list, get_current_order_status_list, get_customers_full_data_by_id, get_customers_main_data_by_id, get_customer_data_with_newsletter, get_customer_ids_from_customers_with_pricelist_download, get_customer_ids_from_registered_adults, get_customer_ids_from_registered_dealers, get_customer_ids_with_newsletter, get_deposits_stats, get_last_customer_id, get_last_order_id, get_last_products_idget_todays_order_ids, get_monthly_order_volume, get_monthly_reversal_quote, get_newsletter_subscribers, get_open_questions, get_products_stock, get_products_total_amount, get_shop_name, get_taxrates_list, get_todays_hits, get_todays_order_volume, get_todays_reversal_quote, get_todays_top_ten_refs, get_todays_visitors, get_traffic_contingent, get_visitors_online, get_vshops_list, get_webspace_contingent, get_weekly_order_volume, get_weekly_reversal_quote, Schnittstelle, update_products_stock, XML, XML API, XML Schnittstelle — admin @ 16:57

verfügbare Calls:

Hier die zur Zeit aktuelle Liste:

Kommando	Ergebnis
get_api_data	gibt Daten über die Schnittstelle zurück
get_last_order_id	gibt die Bestellnummer der aktuellsten Bestellung zurück
get_last_customer_id	gibt die Kundennummer des aktuellsten Kunden zurück
get_last_products_id	gibt die Produkt ID des aktuellsten Produktes zurück
get_todays_order_ids	gibt die Bestellnummern der heutigen Bestellungen zurück
get_todays_order_volume	gibt die Bestellwerte des heutigen Tages zurück
get_weekly_order_volume	gibt die Bestellwerte der aktuellen Woche zurück
get_monthly_order_volume	gibt die Bestellwerte des aktuellen Monats zurück
get_current_languages_list	gibt die im System aktivierten Sprachen zurück
get_current_order_status_list	gibt die im System hinterlegten Bestellstatus zurück
get_todays_reversal_quote	gibt die Stornoquote des heutigen Tages zurück
get_weekly_reversal_quote	gibt die Stornoquote der aktuellen Woche zurück
get_monthly_reversal_quote	gibt die Stornoquote des aktuellen Monats zurück
get_todays_hits	gibt die gezählten und erwarteten Hits des Tages zurück
get_todays_visitors	gibt die gezählten und erwarteten Visitors des Tages zurück
get_todays_top_ten_refs	gibt die Top 10 Referrer des heutigen Tages zurück
get_products_total_amount	gibt die Anzahl aller im System vorhandenen Produkte zurück
get_connected_domains	gibt alle auf den Shop konnektierten Domains zurück
get_newsletter_subscribers	gibt die Zahl der Nesletterabonnenten zurück
get_customer_ids_with_newsletter	gibt die Kundennr. der Kunden mit Newsletterabonnement zurück
get_customer_data_with_newsletter	gibt die Kundendaten der Kunden mit Newsletterabonnement zurück
get_customer_ids_from_registered_dealers	gibt die Kundennr. der Kunden die als Händler registriert sind zurück
get_current_customer_groups_list	gibt die Liste der verfügbaren Kundengruppen zurück
get_customer_ids_from_registered_adults	gibt die Kundennr. der Kunden die als Erwachsene registriert sind zurück
get_customer_ids_from_customers_with_pricelist_download	gibt die Kundennr. der Kunden die Preislisten herunterladen dürfen zurück
get_open_questions	gibt die Anzahl der noch offenen Anfragen zurück.
get_webspace_contingent	gibt das Webspacekontingent für den Shop zurück
get_traffic_contingent	gibt das Traffickontingent für den Shop zurück
get_visitors_online	gibt die aktuellen Besucher online zurück
get_vshops_list	gibt die im System befindlichen V-Shops zurück
get_taxrates_list	gibt die im System befindlichen Steuersätze zurück
get_currencies_list	gibt die die vorhandenen Währungen zurück
get_currently_running_action	gibt die gerade laufende Aktion zurück
get_deposits_stats	gibt die Anzahl der Kunden mit Guthaben sowie das Gesamtguthaben zurück
get_customers_main_data_by_id	gibt die Hauptdaten des Kunden mit der übergebenen Kundennr. zurück
get_customers_full_data_by_id	gibt die kompletten Daten des Kunden mit der übergebenen Kundennr. zurück
update_products_stock	setzt den Bestand des Produktes oder der Produktvariante mit der übergebenen Artikelnummer
get_shop_name	gibt den Namen des Shops zurück
get_products_stock	gibt den Bestand eines Produktes oder einer Produktvariante zurück

Kommentare (0)

my-Warehouse XML API - eine Einführung in die XML Schnittstelle des my-Warehouse Shopsystems Teil 2/3

Abgelegt unter: Allgemein, Tips'n'Tricks | — Tags:API, Authentifikation, Beispielcall, Calls, Kommandoübergabe, Rückgabewerte, Sandbox, Schnittstelle, Schnittstellenarchitektur, Transportmethode, XML, XML API, XML Schnittstelle, Zeichensatz — admin @ 14:29

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:

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:

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.

Kommentare (0)