Webservice API

Webservice API Grundlagen

Nutzung

Der Zugang zum Webservice hat sich an die Webservice Nutzungsbedingungen zu richten.

Zugriffe werden gelogt und ausgewertet. Um Zugriffe/Bandbreite sowie Serverkapazitäten zu sparen wird empfohlen die Anfragen auf den Webservice soweit es geht zu minimieren. Wir behalten uns das Recht vor Zugänge einzuschränken oder gegebenfalls auch zu sperren.
Zugangsdaten dürfen nicht an Dritte weitergegeben werden oder dargestellt werden.

Datenformat

Der Webservice gibt alles im JSON Format zurück. Wir haben uns gegen XML entschieden da JSON inzwischen genauso weit verbreitet ist und gegenüber XML den Overhead reduziert. Mehr Informationen

Zeichencodierung

Die Ausgabe der Daten des Webservices erfolgt in UFT8

Zugang

Der Zugang zum Webservice erfolgt über eine feste HTTP URL.

http://ws.cloud.topdata.de

Für den Zugang zum Webservice werden Zugangsdaten benötigt die sich wie folgt zusammensetzen.

• User ID (%uid%)
• Passwort (%password%)
• Sicherheitscode (%security_key%)

Die Zugangsdaten müssen bei jedem Aufruf des Webservices mit übergeben werden als HTTP Request.

?uid=%uid%&security_key=%security_key%&password=%password%

Weiter sind folgende HTTP Request Variablen pflicht um eine Antwort vom Webservice zu erhalten

• API-Version (%version%)
• Sprache (%language%)

?uid=%uid%&security_key=%security_key%&password=%password%&version=%version%&language=%language%

API-Version

Sollten Änderungen am Webservice statt finden wird eine neue API-Version vergeben. Damit Ihre eigene Applikation nicht immer mit geupdatet werden muss. ACHTUNG Support können wir immer nur für die altuelle API-Version geben.

• Aktuelle APIVersion: 100

?version=100

Sprache

Die Sprache muss nach ISO 639-1 übergeben werden.

?language=en

Webservice API Funktionen

Warengruppen

Sie erhalten unsere kompletten Warengruppenliste

http://ws.cloud.topdata.de/waregroups

Beispiel

Bei Aufruf von:

http://ws.cloud.topdata.de/waregroups?uid=%uid%&security_key=%security_key%&password=%password%&version=%version%&language=%language%

Erhalten Sie folgende JSON Ausgabe:

{
 
    "waregroups": [
        {
            "waregroup_id": 1,
            "parent_waregroup_id": 173,
            "waregroup": "Printmedien"
        },
        {
            "waregroup_id": 3,
            "parent_waregroup_id": 162,
            "waregroup": "Etiketten"
        },
        ...
    ]
}