Im Zuge der Überarbeitung unserer Website haben wir auch eine neue Version (2.0) unserer Web API erstellt. Diese ist bereits aktiv, allerdings arbeiten wir noch an den SDKs und Beispielen. Sobald diese vorliegen, werden wir Sie hier veröffentlichen.
Die bisherige Version (1.0) der Web API bleibt erhalten und kann weiterhin verwendet werden.
Für die Verwendung des Webservice wird ein sog. API Key benötigt. Dieser wird auf Antrag und nach Prüfung durch NEXUS COMPONENTS erstellt und übermittelt. Die Verwendung dieses API Keys wird in Aufruf des Webservice beschrieben. Mit dem Erhalt und der Verwendung des API Keys erklären Sie sich mit den Lizenzbedingungen einverstanden.
Des Weiteren ist eine bestehende Internetanbindung zum Abruf der Daten erforderlich.
Der Aufruf des Webservice erfolgt über das HTTP Protokoll. Die aufzurufende Methode wird durch die URL spezifiziert. Da der Service nur Informationen liefert, aber keinerlei Speicherung oder
Verarbeitung zur Verfügung stellt, erfolgen alle Aufrufe durch die HTTP Methode GET
.
Die URL für einen Methodenaufruf ist folgendermaßen aufgebaut:
http://www.nexus-de.com/webapi/service/catalog/{Methodenname}[/{Parameter}]
Methodenname:/ voneinander getrennt werden, bestehen.
Parameter (optional):/ voneinander getrennt werden.
Beispiel:http://www.nexus-de.com/webapi/service/catalog/groups/100
Ruft die Methode groups des Webservice auf und übergibt den Parameter 100
Bei jedem Aufruf des Service müssen zusätzlich folgende Kopfzeilen übergeben werden:
X-Apikey:X-Language (optional, Standard=“de“):de: Deutschen: EnglischWenn der Methodenaufruf erfolgreich verarbeitet wurde, liefert der Webservice die gewünschten Daten im Dateiformat JSON ("JavaScript Object Notation") zurück. Dabei handelt es sich grundsätzlich um ein einzelnes Objekt oder ein Array von Objekten. Die Klassendefinition der Objekte wird in Punkt 5.5 näher beschrieben.
Tritt bei der Verarbeitung eines Methodenaufrufs ein Fehler auf, wird diese Information durch den Statuscode des Antwortheaders an den aufrufenden Client zurückgeliefert. Mögliche Statuscodes und Ihre Bedeutung sind:
400 (Bad Request):X-Apikey übergeben403 (Forbidden):500 (Internal Server Error):501 (Not Implemented):GET
Der Aufruf der vom Webservice zur Verfügung gestellten Methoden erfolgt wie in Aufruf des Webservice beschrieben. Folgende Methoden werden zur Verfügung gestellt:
Methode overview
Gibt alle Gruppen der obersten Hierarchieebene zurück.
Syntax: http://www.nexus-de.com/webapi/service/catalog/overview
Parameter: keine
Rückgabe: Array von Objekten der Klasse Group oder ein leeres Array, wenn keine Gruppen gefunden wurden
Methode groups
Gibt alle einer bestimmten Gruppe zugeordneter Untergruppen zurück.
Syntax: http://www.nexus-de.com/webapi/service/catalog/groups/{id}
Parameter:
id:Rückgabe: Array von Objekten der Klasse Group oder ein leeres Array, wenn keine Gruppen gefunden wurden
Methode group
Gibt eine bestimmte Gruppe zurück
Syntax: http://www.nexus-de.com/webapi/service/catalog/group/{id}
Parameter:
id:Rückgabe: Objekt der Klasse Group oder null, wenn die Gruppe nicht gefunden wurde.
Methode items
Gibt alle einer Gruppe zuegordneten Serien zurück
Syntax: http://www.nexus-de.com/webapi/service/catalog/items/{id}
Parameter:
id:Rückgabe: Array von Objekten der Klasse Series oder ein leeres Array, wenn der Gruppe keine Serien zugeordnet sind
Methode items/search
Führt eine Suche unter allen in der Datenbank gespeicherten Serien und Artikeln nach dem übergebenen Suchtext durch und gibt die gefundenen Elemente zurück.
Syntax: http://www.nexus-de.com/webapi/service/catalog/items/search/{searchtext}
Parameter:
searchtext:Rückgabe: Array von Objekten der Klasse Series oder ein leeres Array, wenn keine Elemente zu dem genannten Suchbegriff gefunden wurden
Klasse Group
Kapselt eine Gruppe des Online Katalogs
Eigenschaften:
ID:Title:TitleNoBreaks:ImageUrl:ParentID:0, wenn es sich um eine Gruppe der obersten Ebene handelt.Klasse Series
Kapselt eine Serie des Online Katalogs.
Eigenschaften:
ID:Series:Title:TitleNoBreaks:Description:ImageUrl: Gibt die URL des Serienbildes zurück. Serienbilder sind grundsätzlich an der längsten Seite 100 Pixel großHasDatasheet:DatasheetURL: