Übersicht

ELDAS® bietet seinen Datenbezüger einen REST Webservice an. Dadurch ermöglichen wir den dynamischen Zugriff auf unsere umfangreiche Datenbank abhängig von den entsprechenden Lizenzen zur Implementierung eigener Funktionalitäten bei unseren Mitgliedern, Lieferanten, Softwarehäuser sowie weiterer Partner.

Der aktuelle Umfang des Webservice finden Sie unter webservice.eldas.ch. Bei Interesse wenden Sie sich bitte an uns unter info@eldas.ch.

Best Practice Empfehlungen:

Version

Wenn Sie neu beginnen, verwenden Sie bitte v3 der API. Wenn Sie noch v1 oder v2 verwenden, bitten wir Sie, nach Möglichkeit auf v3 umzustellen.

Performance

Der ELDAS® REST Webservice ist grundsätzlich nicht für einen ständigen Live-Zugriff (On-Demand Abfrage) auf die Produktdaten gedacht, sondern für den täglichen Abgleich (z.B. über Nacht) der Produktdaten mit Ihrem Datenbestand. Während vereinzelte Live-Zugriffe auf einzelne Produkte möglich sind, bitten wir Sie entsprechend, von Live-Abfragen eines ganzen Produktsortiments oder permanenten Live-Abfragen von Produkten abzusehen.  Das Caching der Produktdaten in einer lokalen Datenbank der eigenen Lösung wird dringend empfohlen.

• Die tägliche Abfrage des kompletten Produktkatalogs zur Aktualisierung der eigenen Datenbank ist zu vermeiden und nicht notwendig. Für diese Aktualisierung stehen die changed-Methoden GET /api/v3/eldasno/changed/rel/{days} und GET /api/v3/eldasno/changed/abs/{date} zur Verfügung. Mit diesen können Sie relativ (Anzahl Tage zurück) oder absolut (ab einem bestimmten Datum, zum Beispiel 2024-12-01) nur die seither geänderten Produkte abrufen.
• Ein typisches Vorgehen wäre zum Beispiel wie folgt:
  • Einmalige Abfrage aller Produkte (ELDAS-Nummern) mit der Methode GET /api/v3/eldasno/all zur Initialisierung der lokalen Datenbank. Unterteilen der abgefragten Produkte in 500er-Pakete und Abfrage der kompletten Produktdaten mit POST /api/v3/product/{inklTree} in einem Loop.
  • Tägliche Abfrage der zuletzt geänderten Produkte (ELDAS-Nummern) mit GET /api/v3/eldasno/changed/rel/{days} 3-5 Tage zurück, damit - sollte die Schnittstelle einmal nicht funktionieren – keine Änderungen verpasst werden. Unterteilen der abgefragten Produkte in 500er-Pakete und Abfrage der kompletten Produktdaten mit POST /api/v3/product/{inklTree} in einem Loop.

Bitte fragen Sie mit der Methode POST /api/v3/product/{inklTree} Produkte (ELDAS-Nummern) im Idealfall in 500er-Pakete ab (nicht mehr als 1'000 Produkte) in einem Loop ab.

Hinweis: Diese Best Practice ist lediglich eine unverbindliche Empfehlung, wie in einem bestimmten Fall vorzugehen ist. Bei geänderten Anforderungen oder Bedingungen kann mitunter eine andere Vorgehensweise erfolgversprechender sein.

Changelog:

v3 – 01.01.2024

Der Release Candidate V3_RC des REST Webservices wurde nun offiziell bereitgestellt, da die Daten mit den Reifegraden 0-2 eingepflegt sind. Weiter wurden die ETIM-Attributswertbeschreibungen Deutsch/Französisch/Italienisch ergänzt.

v3 RC – 01.01.2023

Mit der Version 3 wurden neue API-Methoden eingeführt, um Aufträge und Mutationen anzulegen und zu verwalten. Weiter können die Regeln für das Mapping einer ETIM Klassen auf die Zolltarifnummern abgefragt werden.

Im Rahmen der ENo Methoden wird neu nach Reifegrad der Artikeldaten unterschieden:

• Reifergrad 0: wird nicht nummeriert
• Reifergrad 1: wird nummeriert
• Reifergrad 2: in Arbeit
• Reifergrad 3: vollständig

Die Version 3 steht als Release Candidate (RC) zur Verfügung. Bei allen Methoden zu den ENo steht aktuell der Reifegrad 3 zur Verfügung. Die Reifegrade 0-2 sind implementiert. Sobald der Stand der Datenpflege diese Abfragen ermöglicht, wird die Version 3 definitiv released. Unter Berücksichtigung dieser Einschränkungen kann die v3 eingesetzt werden, ansonsten steht die v2 weiterhin uneingeschränkt zur Verfügung.

v2 – 01.03.2021

In der Version 2 wurden die meisten API-Methoden umgebaut, sodass sie nur noch ENo zurückliefern und nicht mehr die vollständigen Produktdaten. Die vollständigen Produktdaten können anschliessend mit der POST-Methode /api/v2/product/ abgerufen werfen, in dem man die Liste der ENo übergibt. Bei einer grossen Anzahl von ENo wird empfohlen, die Abfrage in mehrere Abfragen von kleineren Stückzahlen aufzuteilen.

Generell wird ein Umstieg von v1 auf v2 empfohlen; die v1 bleibt aber aus Kompatibilitätsgründen verfügbar.

v1 (myCat)

Die API-Methoden in der Version v1_myCat sind exklusiv für die Katalogproduktion vorgesehen. Der Zugriff darauf ist gesperrt.

v1 – 01.01.2020

Die erste Webservice-Version ist seit dem 01.01.2020 live. Im Laufe vom 2020 wurden noch einige Methoden hinzugefügt:

• Suche nach einer ENo zu einer bestehenden Lieferanten-, Herstellernummer oder GTIN (EAN)
• Suche nach Produkten einer ETIM-Klasse oder einem ETIM-Feature
• Suche nach mehreren Produkten gemäss einer Liste von ENo
• Suche nach allen ENo, die gemäss Lizenz zugelassen sind, als Basis für die gestaffelte Suche nach mehreren Produkten (beispielsweise für die Urladung).