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 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}]
Methodenname:Parameter (optional):
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:
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 im Abschnitt Service Klassen 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):404 (Not Found):500 (Internal Server Error):Der Aufruf der vom Webservice zur Verfügung gestellten Methoden erfolgt wie in Aufruf des Webservice beschrieben. Folgende Methoden werden zur Verfügung gestellt:
listrootgroups 2.0Beschreibung:
Gibt alle Gruppen der obersten Hierarchieebene zurück.
Syntax:
/webapi/catalog/listrootgroups
Rückgabe:
Array von Objekten der Klasse cataloggroup oder ein leeres Array, wenn keine Gruppen gefunden wurden.
listsubgroups 2.0Beschreibung:
Gibt alle einer bestimmten Gruppe zugeordneter Untergruppen zurück.
Syntax:
/webapi/catalog/listsubgroups/{id}
Parameter:
id: ID der übergeordneten Gruppe.Rückgabe:
Array von Objekten der Klasse cataloggroup oder ein leeres Array, wenn keine Gruppen gefunden wurden.
Ausnahmen:
Existiert die im Parameter id angebenene, übergordnete Gruppe nicht, so wird der Fehler 404 (Not Found) ausgelöst.
getgroup 2.0Beschreibung:
Gibt eine bestimmte Gruppe zurück
Syntax:
/webapi/catalog/getgroup/{id}
Parameter:
id: ID der Gruppe.Rückgabe:
Objekt der Klasse cataloggroup.
Ausnahmen:
Existiert die im Parameter id angebenene Gruppe nicht, so wird der Fehler 404 (Not Found) ausgelöst.
listseries 2.0Beschreibung:
Gibt alle einer Gruppe zugeordneten Serien zurück.
Syntax:
/webapi/catalog/listseries/{id}
Parameter:
id: ID der übergeordneten Gruppe.Rückgabe:
Array von Objekten der Klasse catalogseries oder ein leeres Array, wenn der Gruppe keine Serien
zugeordnet sind.
Ausnahmen:
Existiert die im Parameter id angebenene, übergordnete Gruppe nicht, so wird der Fehler 404 (Not Found) ausgelöst.
searchseries 2.0Beschreibung:
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:
searchtext: Zu suchende ZeichenfolgeRückgabe:
Array von Objekten der Klasse catalogseries oder ein leeres Array, wenn keine Elemente zu dem genannten
Suchbegriff gefunden wurden.
getseries 2.1Beschreibung:
Gibt eine bestimmte Serie zurück.
Syntax:
/webapi/catalog/getseries/{id}
Parameter:
id: ID der SerieRückgabe:
Ein Objekt der Klasse catalogseries.
Ausnahmen:
Existiert keine Serie mit der übergebenen ID wird der Fehler 404 (Not Found) ausgelöst.
listseriesfiles 2.1Beschreibung:
Gibt alle downloadbaren Dateien (wie z.B. Datenblätter, 3D Modelle etc.) einer Serie zurück.
Syntax:
/webapi/catalog/listseriesfiles/{id}
Parameter:
id: ID der Serie.Rückgabe:
Array von Objekten der Klasse catalogseriesfile oder ein leeres Array, wenn keine downloadbaren
Dateien gefunden wurden.
Ausnahmen:
Existiert die im Parameter id angebenene Serie nicht, so wird der Fehler 404 (Not Found) ausgelöst.
listseriesmatingparts 2.1Beschreibung:
Gibt alle Serien zurück, die für die übergebenen Serie als Gegenstück eingesetzt werden können.
Syntax:
/webapi/catalog/listseriesmatingparts/{id}
Parameter:
id: ID der Serie.Rückgabe:
Array von Objekten der Klasse catalogseries oder ein leeres Array, wenn zu der Serie keine
Gegenstücke existieren.
Ausnahmen:
Existiert die im Parameter id angebenene Serie nicht, so wird der Fehler 404 (Not Found) ausgelöst.
cataloggroup 2.0Beschreibung:
Kapselt eine Gruppe des Online Katalogs
Eigenschaften:
(string) Id 2.0:
(int) LegacyId 2.0 deprecated internal:
(int) Sort 2.0:
(string) ParentId 2.0:
(string) Title 2.0:
(string) TitleNoBreaks 2.0:
(string) UrlTitle 2.0:
(string) Language 2.0 internal:
(bool) HasImage 2.0:
(string) ImageUrl 2.0:
(int) SubgroupyCount 2.0:
(string) HasSubgroups 2.0:
(int) ItemsCount 2.0:
(string) HasSeries 2.0:
Verwendet von:
listrootgroupslistsubgroupsgetgroupcatalogseries 2.0Beschreibung:
Kapselt eine Serie des Online Katalogs.
Eigenschaften:
(string) Id 2.0:
(int) LegacyId 2.0 deprecated internal:
(string) Series 2.0:
(string) Title 2.0:
(string) Description 2.0:
(string) Keywords 2.0 deprecated:
(bool) HasImage 2.0:
(string) ImageUrl 2.0:
(bool) HasLargeImage 2.1:
(string) LargeImageUrl 2.1:
(int) FilesCount 2.1:
(int) MatingPartsCount 2.1:
Verwendet von:
listseriessearchseriesgetserieslistseriesmatingpartscatalogseriesfile 2.1Beschreibung:
Kapselt eine downloadbare Datei einer Serie.
Eigenschaften:
(string) Id 2.1:
(string) Title 2.1:
(string) Language 2.1 internal:
(string) Filename 2.1:
(string) Description 2.1:
(string) ContentType 2.1:
(int) Size 2.1:
(string) DownloadUrl 2.1:
Verwendet von:
listseriesfilesNeuerungen
getseries hinzugefügtlistseriesfiles hinzugefügtlistseriesmatingparts hinzugefügtcatalogseriesfile hinzugefügtHasLargeImage zu Service Klasse catalogseries hinzugefügtLargeImageUrl zu Service Klasse catalogseries hinzugefügtFilesCount zu Service Klasse catalogseries hinzugefügtMatingPartsCount zu Service Klasse catalogseries hinzugefügtNeue Version 2.0