Inhaltsverzeichnis

Voraussetzungen

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.

Aufruf des Webservice

Der Aufruf des Webservices erfolgt über das HTTPS 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:

https://www.nexus-de.com/webapi/catalog/{Methodenname}[/{Parameter}]

Beispiel:
https://www.nexus-de.com/webapi/catalog/listsubgroups/3874DF9E-F1AF-4CFE-B148-327384D1E57E
Ruft die Methode listsubgroups des Webservice auf und übergibt den Parameter 3874DF9E-F1AF-4CFE-B148-327384D1E57E

Bei jedem Aufruf des Service müssen zusätzlich folgende Kopfzeilen übergeben werden:

Datenformat

Wenn 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 im Abschnitt Service Klassen näher beschrieben.

Fehlerbehandlung

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:

Service Methoden

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 listrootgroups

Gibt alle Gruppen der obersten Hierarchieebene zurück.

Syntax: /webapi/catalog/listrootgroups

Parameter: keine

Rückgabe: Array von Objekten der Klasse cataloggroup oder ein leeres Array, wenn keine Gruppen gefunden wurden

Methode listsubgroups

Gibt alle einer bestimmten Gruppe zugeordneter Untergruppen zurück.

Syntax: /webapi/catalog/listsubgroups/{id}

Parameter:

Rückgabe: Array von Objekten der Klasse cataloggroup oder ein leeres Array, wenn keine Gruppen gefunden wurden

Methode getgroup

Gibt eine bestimmte Gruppe zurück

Syntax: /webapi/catalog/getgroup/{id}

Parameter:

Rückgabe: Objekt der Klasse cataloggroup oder null, wenn die Gruppe nicht gefunden wurde.

Methode listseries

Gibt alle einer Gruppe zuegordneten Serien zurück

Syntax: /webapi/catalog/listseries/{id}

Parameter:

Rückgabe: Array von Objekten der Klasse catalogseries oder ein leeres Array, wenn der Gruppe keine Serien zugeordnet sind

Methode searchseries

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: /webapi/catalog/searchseries/{searchtext}

Parameter:

Rückgabe: Array von Objekten der Klasse catalogseries oder ein leeres Array, wenn keine Elemente zu dem genannten Suchbegriff gefunden wurden

Methode listseriesfiles

Listet alle downloadbaren Dateien (wie z.B. Datenblätter, 3D Modelle etc.) einer Serie zurück

Syntax: /webapi/catalog/listseriesfiles/{id}

Parameter:

Rückgabe: Array von Objekten der Klasse catalogseriesfile oder ein leeres Array, wenn keine downloadbaren Dateien gefunden wurden.

Methode listseriesmatingparts

Liste alle einer Serie zugeordneten Gegenstücke auf

Syntax: /webapi/catalog/listseriesmatingparts/{id}

Parameter:

Rückgabe: Array von Objekten der Klasse catalogseries oder ein leeres Array, wenn zu der Serie keine Gegenstücke existieren.

Service Klassen

Klasse cataloggroup

Kapselt eine Gruppe des Online Katalogs

Eigenschaften:

Klasse catalogseries

Kapselt eine Serie des Online Katalogs.

Eigenschaften:

Klasse catalogseriesfile

Kapselt eine downloadbare Datei einer Serie

Eigenschaften: