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

Beschreibung:

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.

Methode listsubgroups

Beschreibung:

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.

Methode getgroup

Beschreibung:

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.

Methode listseries

Beschreibung:

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.

Methode searchseries

Beschreibung:

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 Zeichenfolge

Rückgabe:

Array von Objekten der Klasse catalogseries oder ein leeres Array, wenn keine Elemente zu dem genannten Suchbegriff gefunden wurden.

Methode getseries

Beschreibung:

Gibt eine bestimmte Serie zurück.

Syntax:

/webapi/catalog/getseries/{id}

Parameter:

  • id: ID der Serie

Rückgabe:

Ein Objekt der Klasse catalogseries.

Ausnahmen:

Existiert keine Serie mit der übergebenen ID wird der Fehler 404 (Not Found) ausgelöst.

Methode listseriesfiles

Beschreibung:

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.

Methode listseriesmatingparts

Beschreibung:

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.

Service Klassen

Klasse cataloggroup

Beschreibung:

Kapselt eine Gruppe des Online Katalogs

Eigenschaften:

  • (string) Id :
    Gibt die ID der Gruppe zurück
  • (int) LegacyId :
    Gibt die ID der Gruppe zurück, die in Version 1.0 der Service API verwendet wurde.
    Hinweise:
    Nur Gruppen, die vor dem Start der Service API Version 2.0 im Online Katalog bestanden, haben eine solche ID.
  • (int) Sort :
    Gibt die Position innerhalb der Sortierung der Gruppen zurück. Die Sortierung sollte in absteigender Reihenfolge erfolgen.
  • (string) ParentId :
    Gibt ID der übergeordneten Gruppe zurück. Bei Gruppen der obersten Ebene wird eine leere Zeichenfolge zurückgegeben.
  • (string) Title :
    Gibt den Titel der Gruppe zurück
  • (string) TitleNoBreaks :
    Gibt den Titel der Gruppe zurück, wobei alle HTML Zeilenumbrüche durch Leerzeichen ersetzt wurden.
  • (string) UrlTitle :
    Gibt den Titel der Gruppe in einem Format zurück, dass in URLs verwendet werden kann (zum Beispiel für SEO).
  • (string) Language :
    Gibt die verwendete Sprache zurück.
  • (bool) HasImage :
    Gibt an, ob zu dieser Gruppe ein Listenbild existiert.
  • (string) ImageUrl :
    Gibt die URL des Gruppenbildes zurück. Gruppenbilder sind grundsätzlich 100x100 Pixel groß. Ist für die Gruppe kein Bild hinterlegt, wird die URL des Standardbildes für Gruppen (NEXUS COMPONENTS Logo) zurückgegegeben.
  • (int) SubgroupyCount :
    Gibt die Anzahl der dieser Gruppe zugeordneten Untergruppen zurück.
  • (string) HasSubgroups :
    Gibt einen Wert zurück der anzeigt ob die Gruppe noch weitere Untergruppen besitzt.
  • (int) ItemsCount :
    Gibt die Anzahl der dieser Gruppe zugeordneten Serien zurück.
  • (string) HasSeries :
    Gibt einen Wert zurück der anzeigt ob die Gruppe Serien beinhaltet.

Verwendet von:

Klasse catalogseries

Beschreibung:

Kapselt eine Serie des Online Katalogs.

Eigenschaften:

  • (string) Id :
    Gibt die ID der Serie zurück
  • (int) LegacyId :
    Gibt die ID der Serie zurück, die in Version 1.0 der Service API verwendet wurde.
    Hinweise:
    Nur Serien, die vor dem Start der Service API Version 2.0 im Online Katalog bestanden, haben eine solche ID.
  • (string) Series :
    Gibt die Nummer bzw. Kurzbezeichnung der Serie zurück
  • (string) Title :
    Gibt den Titel der Serie zurück
  • (string) Description :
    Gibt die Beschreibung der Serie zurück
  • (string) Keywords :
    Gibt eine Sammlung von Schlüsselwörtern (Suchbegriffen) zurück, dieser Serie zugeordnet sind.
  • (bool) HasImage :
    Gibt an, ob zu der Serie ein Listenbild hinterlegt ist.
  • (string) ImageUrl :
    Gibt die URL des Listenbildes der Serie zurück. Listenbilder sind grundsätzlich an der längsten Seite 100 Pixel groß. Ist für die Serie keine Listenbild hinterlegt, wird die URL des Standard Listenbildes für Gruppen (NEXUS COMPONENTS Logo) zurückgegeben.
  • (bool) HasLargeImage :
    Gibt an, ob zu der Serie eine Großansicht (Bild) hinterlegt ist.
  • (string) LargeImageUrl :
    Gibt die URL für die Großansicht der Serie zurück.
  • (int) FilesCount :
    Gibt die Anzahl der downloadbaren Dateien, die dieser Serie zugeordnet sind, zurück
  • (int) MatingPartsCount :
    Gibt die Anzahl der Serien, die dieser als mögliches Gegenstück zugeordnet sind, zurück.

Verwendet von:

Klasse catalogseriesfile

Beschreibung:

Kapselt eine downloadbare Datei einer Serie.

Eigenschaften:

  • (string) Id :
    Gibt die ID der Datei zurück
  • (string) Title :
    Gibt den Titel der Datei zurück
  • (string) Language :
    Gibt die verwendete Sprache zurück.
  • (string) Filename :
    Gibt den Namen der Datei inkl. Dateiendung zurück.
  • (string) Description :
    Gibt die erweiterte Beschreibung der Datei zurück.
  • (string) ContentType :
    Gibt den MIME Inhaltstyp der Datei zurück
  • (int) Size :
    Gibt die Größe der Datei in Bytes zurück
  • (string) DownloadUrl :
    Gibt die Url zum Download der Datei zurück.

Verwendet von:

Versionshistorie

Version 2.1

Neuerungen

Version 2.0

Neue Version 2.0