Webservice API: Unterschied zwischen den Versionen
(new api version) |
|||
Zeile 24: | Zeile 24: | ||
</p> | </p> | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de</source> |
<translate> | <translate> | ||
<!--T:2--> | <!--T:2--> | ||
Zeile 93: | Zeile 93: | ||
<p>Sie erhalten alle für Ihren Zugang aktivierten Produkte als [[Webservice_API#Produktliste|Produktliste]].</p> | <p>Sie erhalten alle für Ihren Zugang aktivierten Produkte als [[Webservice_API#Produktliste|Produktliste]].</p> | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/my_products</source> |
<translate> | <translate> | ||
<!--T:8--> | <!--T:8--> | ||
Zeile 99: | Zeile 99: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/my_products? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 114: | Zeile 114: | ||
<h4>Meine Produkte nur mit Artikel-Nr.</h4> | <h4>Meine Produkte nur mit Artikel-Nr.</h4> | ||
<p>Sie erhalten alle für Ihren Zugang aktivierten Produkte als [[Webservice_API#Produktliste|Produktliste]] wo eine Artikel-Nr. eines zugelassenen Anbieters hinterlegt ist.</p> | <p>Sie erhalten alle für Ihren Zugang aktivierten Produkte als [[Webservice_API#Produktliste|Produktliste]] wo eine Artikel-Nr. eines zugelassenen Anbieters hinterlegt ist.</p> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/distributor_products</source> |
<h3>Warengruppen</h3> | <h3>Warengruppen</h3> | ||
<p>ruft die kompletten Warengruppen als Liste auf:</p> | <p>ruft die kompletten Warengruppen als Liste auf:</p> | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/waregroups</source> |
<translate> | <translate> | ||
<!--T:10--> | <!--T:10--> | ||
Zeile 124: | Zeile 124: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/waregroups? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 159: | Zeile 159: | ||
* Warengruppen ID (%waregroup_id%) | * Warengruppen ID (%waregroup_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/waregroup/%warengroup_id%</source> |
<translate> | <translate> | ||
<!--T:13--> | <!--T:13--> | ||
Zeile 165: | Zeile 165: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/waregroup/%warengroup_id%? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 215: | Zeile 215: | ||
</p> | </p> | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_list</source> |
<translate> | <translate> | ||
<!--T:53--> | <!--T:53--> | ||
Zeile 221: | Zeile 221: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_list?products=123456,789012& |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 236: | Zeile 236: | ||
* Filter (%filter%) | * Filter (%filter%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product</source> |
<translate> | <translate> | ||
<!--T:17--> | <!--T:17--> | ||
Zeile 242: | Zeile 242: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product/145080?filter=all& |
uid=%uid%& | uid=%uid%& | ||
security_key=%security_key%& | security_key=%security_key%& | ||
Zeile 467: | Zeile 467: | ||
* Produkt ID (%product_id%) | * Produkt ID (%product_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/bundle_content/%product_id%</source> |
<translate> | <translate> | ||
<!--T:22--> | <!--T:22--> | ||
Zeile 473: | Zeile 473: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/bundle_content/%product_id%? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 490: | Zeile 490: | ||
* Produkt ID (%product_id%) | * Produkt ID (%product_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_alternates/%product_id%</source> |
<translate> | <translate> | ||
<!--T:25--> | <!--T:25--> | ||
Zeile 496: | Zeile 496: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_alternates/%product_id%? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 513: | Zeile 513: | ||
* Produkt ID (%product_id%) | * Produkt ID (%product_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_is_alternate_of/%product_id%</source> |
<translate> | <translate> | ||
<!--T:28--> | <!--T:28--> | ||
Zeile 519: | Zeile 519: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_is_alternate_of/%product_id%? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 535: | Zeile 535: | ||
* Produkt ID (%product_id%) | * Produkt ID (%product_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_variants/%product_id%</source> |
<translate> | <translate> | ||
<p>'''Beispiel'''</p> | <p>'''Beispiel'''</p> | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_variants/%product_id%? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 556: | Zeile 556: | ||
* Produkt ID (%product_id%) | * Produkt ID (%product_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_accessories/%product_id%</source> |
<translate> | <translate> | ||
<!--T:31--> | <!--T:31--> | ||
Zeile 562: | Zeile 562: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_accessories/%product_id%? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 579: | Zeile 579: | ||
* Produkt ID (%product_id%) | * Produkt ID (%product_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_same_accessories/%product_id%</source> |
<translate> | <translate> | ||
<!--T:34--> | <!--T:34--> | ||
Zeile 585: | Zeile 585: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_same_accessories/%product_id%? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 602: | Zeile 602: | ||
* Produkt ID (%product_id%) | * Produkt ID (%product_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_application_in/%product_id%</source> |
<translate> | <translate> | ||
<!--T:37--> | <!--T:37--> | ||
Zeile 608: | Zeile 608: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_application_in/%product_id%? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 625: | Zeile 625: | ||
* Produkt ID (%product_id%) | * Produkt ID (%product_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_same_application_in/%product_id%</source> |
<translate> | <translate> | ||
<!--T:40--> | <!--T:40--> | ||
Zeile 631: | Zeile 631: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/product_same_application_in/%product_id%? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 648: | Zeile 648: | ||
* Anbieter ID (%distributor_id%) | * Anbieter ID (%distributor_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/distributor/%distributor_id%</source> |
<translate> | <translate> | ||
<!--T:44--> | <!--T:44--> | ||
Zeile 654: | Zeile 654: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/distributor/%distributor_id%? |
filter=%filter%& | filter=%filter%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 675: | Zeile 675: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/finder/ink_toner/brands? |
uid=%uid%& | uid=%uid%& | ||
security_key=%security_key%& | security_key=%security_key%& | ||
Zeile 688: | Zeile 688: | ||
* Drucker-Hersteller ID wird benötigt (%brand_id%) | * Drucker-Hersteller ID wird benötigt (%brand_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/finder/ink_toner/modelseries? |
brand_id=%brand_id%& | brand_id=%brand_id%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 702: | Zeile 702: | ||
* Drucker-Hersteller ID wird benötigt (%brand_id%) | * Drucker-Hersteller ID wird benötigt (%brand_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/finder/ink_toner/devicetypes? |
brand_id=%brand_id%& | brand_id=%brand_id%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 718: | Zeile 718: | ||
* Drucker-Typen ID optional benötigt (%devicetype_id%) | * Drucker-Typen ID optional benötigt (%devicetype_id%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/finder/ink_toner/models? |
brand_id=%brand_id%& | brand_id=%brand_id%& | ||
modelserie_id=%modelserie_id%& //devicetype_id=%devicetype_id%& | modelserie_id=%modelserie_id%& //devicetype_id=%devicetype_id%& | ||
Zeile 734: | Zeile 734: | ||
* Suchbegriff wird benötigt (%q%) | * Suchbegriff wird benötigt (%q%) | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/finder/ink_toner/search? |
q=%q%& | q=%q%& | ||
uid=%uid%& | uid=%uid%& | ||
Zeile 755: | Zeile 755: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/match/oem? |
uid=%uid%& | uid=%uid%& | ||
security_key=%security_key%& | security_key=%security_key%& | ||
Zeile 768: | Zeile 768: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/match/pcd? |
uid=%uid%& | uid=%uid%& | ||
security_key=%security_key%& | security_key=%security_key%& | ||
Zeile 781: | Zeile 781: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/match/ean? |
uid=%uid%& | uid=%uid%& | ||
security_key=%security_key%& | security_key=%security_key%& | ||
Zeile 794: | Zeile 794: | ||
Bei Aufruf von: | Bei Aufruf von: | ||
</translate> | </translate> | ||
− | <source lang="text"> | + | <source lang="text">https://ws.topdata.de/match/distributor? |
uid=%uid%& | uid=%uid%& | ||
security_key=%security_key%& | security_key=%security_key%& | ||
Zeile 810: | Zeile 810: | ||
//receive data | //receive data | ||
− | $data = file_get_contents(' | + | $data = file_get_contents('https://ws.topdata.de/product/145080?uid=...&security_key=...&password=..&version=100&language=de'); |
//decode json data | //decode json data |
Version vom 20. Februar 2020, 09:57 Uhr
Inhaltsverzeichnis
Webservice API Grundlagen
Nutzung
Mit dem Zugang zum Webservice haben Sie automatisch unsere Webservice Nutzungsbedingungen verstanden und akzeptiert.
Zugriffe werden geloggt und ausgewertet. Um Zugriffe/Bandbreite sowie Serverkapazitäten zu sparen, wird empfohlen, die Anfragen an den Webservice (soweit es geht), durch Datencaching zu minimieren. Wir behalten uns das Recht vor, Zugänge einzuschränken oder gegebenenfalls auch zu sperren, sollte der Zugriff zum Webservice über ein plausibles Mass hinausgehen.
Zugangsdaten dürfen nicht an Dritte weitergegeben oder öffentlich dargestellt werden.
Für Ihre Zugangsdaten sind bestimmte, vorher vereinbarte, Daten freigegeben.
Datenformat
Die Rückgabe des Webservices erfolgt im JSON Format. Wir haben uns gegen XML entschieden, da JSON inzwischen genauso weit verbreitet ist und gegenüber XML den Overhead reduziert. Mehr Informationen
Zeichencodierung
Die Ausgabe der Daten des Webservices erfolgt in UFT8
Zugang
Der Abruf der Webservice-Daten erfolgt über eine feste HTTP URL.
https://ws.topdata.de
Für den Zugang zum Webservice werden Zugangsdaten benötigt, die sich wie folgt zusammensetzen:
- User ID (%uid%)
- Passwort (%password%)
- Sicherheitscode (%security_key%)
?uid=%uid%&security_key=%security_key%&password=%password%
Weiter sind folgende HTTP Request Variablen Pflicht, um eine Antwort vom Webservice zu erhalten
- API-Version (%version%)
- Sprache (%language%)
?uid=%uid%&security_key=%security_key%&password=%password%&version=%version%&language=%language%
API-Version
Sollten Änderungen am Webservice stattfinden, wird eine neue API-Version vergeben, damit Ihre eigene Applikation nicht immer mit geupdatet werden muss. ACHTUNG, Support unsererseits kann nur für die jeweils aktuelle API-Version geleistet werden.
- Aktuelle APIVersion: 107
?version=107
Sprache
Die Sprache muss nach ISO 639-1 übergeben werden.
?language=en
Error Codes
Alle Fehler im Überblick
Fehler Code | Fehler Beschreibung |
---|---|
100 | Unbekannter Fehler |
101 | 404 - Seite nicht gefunden |
102 | User ID nicht vorhanden oder nicht valide |
103 | Sicherheitscode nicht vorhanden oder nicht valide |
104 | Passwort nicht vorhanden oder nicht valide |
105 | API-Version nicht vorhanden oder nicht valide |
106 | Authentifizierung fehlgeschlagen |
107 | Sprache nicht vorhanden oder nicht valide |
108 | Template nicht gefunden (Bitte Service informieren) |
109 | Template Fehler (Bitte Service informieren) |
110 | Filter nicht vorhanden oder nicht valide |
200 | Produkt nicht gefunden |
Webservice API Funktionen
Meine Produkte
Sie erhalten alle für Ihren Zugang aktivierten Produkte als Produktliste.
https://ws.topdata.de/my_products
Beispiel
Bei Aufruf von:
https://ws.topdata.de/my_products? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Produktliste als Rückgabe.
Meine Produkte nur mit Artikel-Nr.
Sie erhalten alle für Ihren Zugang aktivierten Produkte als Produktliste wo eine Artikel-Nr. eines zugelassenen Anbieters hinterlegt ist.
https://ws.topdata.de/distributor_products
Warengruppen
ruft die kompletten Warengruppen als Liste auf:
https://ws.topdata.de/waregroups
Beispiel
Bei Aufruf von:
https://ws.topdata.de/waregroups? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie folgende JSON Ausgabe:
{ "waregroups": [ { "waregroup_id": 1, "parent_waregroup_id": 173, "waregroup": "Printmedien" }, { "waregroup_id": 3, "parent_waregroup_id": 162, "waregroup": "Etiketten" }, ... ] }
Produkte
Ruft alle enthalten Produkte zu einer bestimmten Warengruppe ab. Diese werden als Produktliste zurückgegeben. Dafür ist die Warengruppen ID notwendig. Diese erhalten Sie z.B. aus dem Aufruf der Warengruppen oder sie ist bei einem der Produkte hinterlegt
- Warengruppen ID (%waregroup_id%)
https://ws.topdata.de/waregroup/%warengroup_id%
Beispiel
Bei Aufruf von:
https://ws.topdata.de/waregroup/%warengroup_id%? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Produktliste als Rückgabe
Produktliste
Die Produktliste enthält alle vom Filter zugelassenen Informationen zu den Produkten und wird bei bestimmten Webservice-Aufrufen zurückgegeben. Es gelten die selben Filterangaben wie beim Produkt
- Warengruppen Produkte
- bundle_content
- product_alternates
- product_is_alternate_of
- product_variants
- product_accessories
- product_application_in
- Anbieter Produkte
Beispiel
{ "page": { "count_products": 694, "products_per_page": 50, "page": 1, "available_pages": 14 }, "products": [ ... ] }
Um den Traffic und die Ladezeit gering zu halten, wird die Produktliste immer in mehrere Seiten unterteilt. Die einzelnen Seiten können über eine weitere HTTP Request Variable angesteuert werden:
?page=3
Die Produktliste beinhaltet Informationen über die Anzahl der Seiten, die Anzahl der Produkte, die Anzahl der Produkte pro Seite sowie die aktuell ausgewählte Unterseite.
Die Produkte in der Produktliste werden analog zum Aufruf eines einzelnen Produktes dargestellt.
mehrere Produkte auf einmal abrufen (ab Version 103)
Sie können auch einer Webservice Abfrage mehrere Produkt-IDs übergeben um dazu die Produktliste zu erhalten. Diese werden per Komma getrennten String übergeben. ACHTUNG es sind maxmimal 50 Produkt-IDs zugelassen (mehr werden ignoriert).
https://ws.topdata.de/product_list
Beispiel
Bei Aufruf von:
https://ws.topdata.de/product_list?products=123456,789012& filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Produktliste mit 2 Produkten (123456 und 789012) als Rückgabe.
Produkt
Abruf eines einzelnen Produktes mit dem vom Filter zugelassenen Informationen vom Webservice. Dafür ist die Produkt ID notwendig.
- Produkt ID (%products_id%)
- Filter (%filter%)
https://ws.topdata.de/product
Beispiel für den Artikel 92298A von HP
Bei Aufruf von:
https://ws.topdata.de/product/145080?filter=all& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie folgende JSON Ausgabe:
{ "product": { "products_id": 145080, "creation_date": null, "edit_date": null, "short_description": "Original Hewlett Packard Toner-Kartusche schwarz (92298A, 98A)", "manufacturer": "Hewlett Packard (HP)", "name": "", "oems": [ "92298A", "98A" ], "eans": [ "088698005668" ], "reference_oems": [ "1538A003", "M2473G/A", "LN0XX-AA" ], "bundle_content_oems": [ ], "waregroups": [ { "waregroup_id": 57, "waregroup": "Toner-Kartuschen", "main_waregroup": true, "waregroup_tree": [ { "waregroup_id": 157, "waregroup": "Bürobedarf" }, { "waregroup_id": 173, "waregroup": "Druckerzubehör" }, { "waregroup_id": 199, "waregroup": "Laserdrucker" }, { "waregroup_id": 56, "waregroup": "Toner" }, { "waregroup_id": 57, "waregroup": "Toner-Kartuschen" } ] } ], "specifications": [ { "specification_id": 6, "specification": "Seitendeckung", "attribute_id": 4521, "attribute": "bei 5% Seitendeckung", "attribute_synonym": "", "count": 1 }, ... ], "images": [ { "type_id": 5, "type_id_string": "005", "type_key": "image_type_pack_and_product", "thumb": { "url": "http://image.cloud.topdata.de/t/145080.jpg", "url_own_filename": "http://image.cloud.topdata.de/t/145080/" }, "normal": { "url": "http://image.cloud.topdata.de/n/145080.jpg", "url_own_filename": "http://image.cloud.topdata.de/n/145080/" } }, { "type_id": 10, "type_id_string": "010", "type_key": "image_type_pack", "thumb": { "url": "http://image.cloud.topdata.de/t/145080.jpg", "url_own_filename": "http://image.cloud.topdata.de/t/145080/" }, "normal": { "url": "http://image.cloud.topdata.de/n/145080.jpg", "url_own_filename": "http://image.cloud.topdata.de/n/145080/" } }, ... ], "bundle_content": [ ], "product_alternates": { "ws_list_url": "/product_alternates/145080", "products": [ [ 145070, ... ] ] }, "product_is_alternate_of": { "ws_list_url": "/product_is_alternate_of/145080", "products": [ [ 145070, ... ] ] }, "product_accessories": [ ], "product_application_in": [ ], "distributors": [ ] } }
Bei der Produktliste werden die Produkte ebenso übergeben.
Filter
ab Version 103 pflicht
Die Produkteigenschaften lassen sich filtern um die JSON Rückgabe des Webservice zu minimieren. Wenn nicht alle Informationen benötigt werden, kann korrektes Filtern beim umwandeln von JSON in ein Objekt in Ihrer Anwendung sehr viel Zeit sparen.
- Filter (%filter%)
?filter=all
Folgender Grundfilter steht zur Verfügung "all". Damit wird Grundsätzlich alles zurück gegeben. Wenn Sie nicht alles benötigen können Sie aus der folgenden Tabelle andere Filter benutzen. Diese lassen sich auch kombiniert übergeben mit komma getrennt.
?filter=specifications,product_alternates
Variable | Beschreibung | Filterkeys |
---|---|---|
reference_oems | Falls das Produkt eine Alternative ist, kommen hier die OEMs zu den entsprechenden Produkten | |
bundle_content_oems | Falls das Produkt ein Bundle ist, kommen hier die OEMs der Einzelprodukte | |
waregroups | Warengruppen zum Produktes | waregroups |
specifications | Spezifikationen des Produktes | specifications |
images | Bilder zum Produkt | images |
bundle_content | Falls das Produkt ein Bundle ist, kommen hier die Produkt IDs der Einzelprodukte | bundle_content |
product_alternates | Alternative Produkt IDs zum Produkt | product_alternates |
product_is_alternate_of | Produkt ist eine Alternative der genannten Produkt IDs | product_is_alternate_of |
product_variants | Alle Produkte dieser Variantengruppe (ab Version 104) | variants |
product_accessories | Zubehör Produkt IDs zum Produkt | product_accessories |
product_same_accessories | Alle Produkt IDs mit dem selben Zubehör zum Produkt | product_same_accessories |
product_application_in | Produkt ist Zubehör von den genannten Produkt IDs | product_application_in |
product_same_application_in | Alle Produkt IDs mit dem selben Elternprodukt wozu es ein Zubehör ist vom Produkt | product_same_application_in |
child_extra_infos | Grundinfos zu den Verknüpften Produkten (Hersteller, Produktname und Kurzbeschreibung) (ab Verion 102) | child_extra_infos |
distributors | verfügbare Anbieter und deren Artikelnummern |
Variable | Beschreibung |
---|---|
images | Bilder erhalten Sie nur dann, wenn diese für Ihren Zugang aktiviert wurden |
distributors | Sie erhalten jeweils nur die Lieferanten, die für Ihren Zugang aktiviert wurden |
iframe
ab Version 103 verfügbar
Wenn Sie von uns die Option "ifame" für Sie aktiviert ist, erhalten Sie zu jedem Produkt eine iframe URL. Damit können Sie ganz unkompliziert in jedes Ihrer Projekte unsere Produktdaten einbinden.
Anhand von Anpassungen an der iframe URL können Passagen aus dem iframe aktivieren. Der Rest wird automatisch deaktiviert und nicht angezeigt.
Die Produkt ID steht in der URL sowie die Sprache. Diese lassen sich anpassen.
Um das iframe nutzen zu können sind ein User und ein Key nötig (ACHTUNG nicht die Zugangsdaten vom Webservice). Dieses erhalten Sie von uns.
Das iframe lässt sich über ein einfaches iframe html Tag einbinden. Mehr Informationen hier.
- zu aktivierende Blöcke (%activate%)
Beispiel (zeigt alles)
http://rohdaten.topdata.de/iframe/123456/de/?user=XXX&key=XXX
Beispiel (zeigt nur das Bilderkarussel)
http://rohdaten.topdata.de/iframe/123456/de/?user=XXX&key=XXX&activate=images
Variable | Beschreibung |
---|---|
head | Seitenkopf (Artikel Kurzbeschreibung) |
images | Bilderkarussel |
description | Der Beschreibungsreiter |
application_in | Der Einsetzbar in Reiter |
product_accessories | Der Zubehörreiter |
product_same_accessories | Der Ähnliche Produkte Reiter für Geräte |
product_same_application_in | Der Ähnliche Produkte Reiter für Zubehör |
bundle_content
Ruft zu einem bestimmten Bundle-Produkt die enthalten Produkte ab. Diese werden als Produktliste zurückgegeben. Dafür ist die Produkt ID des Bundles notwendig.
- Produkt ID (%product_id%)
https://ws.topdata.de/bundle_content/%product_id%
Beispiel
Bei Aufruf von:
https://ws.topdata.de/bundle_content/%product_id%? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Produktliste als Rückgabe.
product_alternates
Ruft zu einem bestimmten Produkt die Alternativprodukte ab. Diese werden als Produktliste zurückgegeben. Dafür ist die Produkt ID notwendig.
- Produkt ID (%product_id%)
https://ws.topdata.de/product_alternates/%product_id%
Beispiel
Bei Aufruf von:
https://ws.topdata.de/product_alternates/%product_id%? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Produktliste als Rückgabe.
product_is_alternate_of
Ruft zu einem bestimmten Alternativprodukt diejenigen Produkte ab, zu denen es alternativ ist. Diese werden als Produktliste zurückgegeben. Dafür ist die Produkt ID notwendig.
- Produkt ID (%product_id%)
https://ws.topdata.de/product_is_alternate_of/%product_id%
Beispiel
Bei Aufruf von:
https://ws.topdata.de/product_is_alternate_of/%product_id%? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten sie die Produktliste als Rückgabe.
product_variants
Ruft zu einem bestimmten Produkt die Variantenprodukte ab. Diese werden als Produktliste zurückgegeben. (ab Version 104) Dafür ist die Produkt ID notwendig.
- Produkt ID (%product_id%)
https://ws.topdata.de/product_variants/%product_id%
Beispiel
Bei Aufruf von:
https://ws.topdata.de/product_variants/%product_id%? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Produktliste als Rückgabe.
product_accessories
Ruft zu einem bestimmten Produkt die Zubehörprodukte ab. Diese werden als Produktliste zurückgegeben. Dafür ist die Produkt ID notwendig.
- Produkt ID (%product_id%)
https://ws.topdata.de/product_accessories/%product_id%
Beispiel
Bei Aufruf von:
https://ws.topdata.de/product_accessories/%product_id%? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Produktliste als Rückgabe.
product_same_accessories
Ruft zu einem bestimmten Produkt die Produkte ab mit den dem selben Zubehör. Diese werden als Produktliste zurückgegeben. Dafür ist die Produkt ID notwendig.
- Produkt ID (%product_id%)
https://ws.topdata.de/product_same_accessories/%product_id%
Beispiel
Bei Aufruf von:
https://ws.topdata.de/product_same_accessories/%product_id%? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Produktliste als Rückgabe.
product_application_in
Ruft zu einem bestimmten Produkt die Produkte ab wozu es ein Zubehör ist. Diese werden als Produktliste zurückgegeben. Dafür ist die Produkt ID notwendig.
- Produkt ID (%product_id%)
https://ws.topdata.de/product_application_in/%product_id%
Beispiel
Bei Aufruf von:
https://ws.topdata.de/product_application_in/%product_id%? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Produktliste als Rückgabe.
product_same_application_in
Ruft zu einem bestimmten Produkt die Produkte ab die genauso ein Zubehör sind. Diese werden als Produktliste zurückgegeben. Dafür ist die Produkt ID notwendig.
- Produkt ID (%product_id%)
https://ws.topdata.de/product_same_application_in/%product_id%
Beispiel
Bei Aufruf von:
https://ws.topdata.de/product_same_application_in/%product_id%? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Produktliste als Rückgabe.
Anbieter Produkte
Ruft zu einem bestimmten Anbieter die Produkte ab. Diese werden als Produktliste zurückgegeben. Dafür ist die Anbieter ID notwendig. Diese ist z.B. bei einem der Produkte einsehbar.
- Anbieter ID (%distributor_id%)
https://ws.topdata.de/distributor/%distributor_id%
Beispiel
Bei Aufruf von:
https://ws.topdata.de/distributor/%distributor_id%? filter=%filter%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
Produktfinder
Hier werden die Daten fertig aufbereitet zurück geliefert um diese direkt als Produktfinder zu verwenden.
Tinten-Toner Finder
Der Tinten Toner Finder dient dafür sein passendes Verbrauchsmaterial zu seinem Drucker zu finden. Das ganze passiert in 2-3 Schritten.
- Drucker-Hersteller (Auswahl Pflicht) Schritt 1
- Drucker-Modellserien (Auswahl Optional) Schritt 2
- Drucker-Typen (Auswahl Optional) Schritt 2
- Drucker-Modelle (Auswahl Pflicht) Schritt 3
- Drucker-Modell Textsuche
Drucker-Hersteller
Bei Aufruf von:
https://ws.topdata.de/finder/ink_toner/brands? uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Drucker-Hersteller als Rückgabe.
Drucker-Modellserien
Bei Aufruf von:
- Drucker-Hersteller ID wird benötigt (%brand_id%)
https://ws.topdata.de/finder/ink_toner/modelseries? brand_id=%brand_id%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Modellserien als Rückgabe.
Drucker-Typen
Bei Aufruf von:
- Drucker-Hersteller ID wird benötigt (%brand_id%)
https://ws.topdata.de/finder/ink_toner/devicetypes? brand_id=%brand_id%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Drucker-Typen als Rückgabe.
Drucker-Modelle
Bei Aufruf von:
- Drucker-Hersteller ID wird benötigt (%brand_id%)
- Drucker-Modellserien ID optional benötigt (%modelserie_id%)
- Drucker-Typen ID optional benötigt (%devicetype_id%)
https://ws.topdata.de/finder/ink_toner/models? brand_id=%brand_id%& modelserie_id=%modelserie_id%& //devicetype_id=%devicetype_id%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Drucker-Modelle als Rückgabe.
Nach auswahl eines Druckers lässt sich das passende Verbrauchsmaterial über product_accessories aufrufen.
Drucker-Modell Textsuche
Bei Aufruf von:
- Suchbegriff wird benötigt (%q%)
https://ws.topdata.de/finder/ink_toner/search? q=%q%& uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
erhalten Sie die Drucker-Modelle als Rückgabe.
Nach auswahl eines Druckers lässt sich das passende Verbrauchsmaterial über product_accessories aufrufen.
Mapping
Nutzen Sie das Mapping um schnell unseren Produktbestand mit Ihrem abzugeleichen. So ist es nicht nötig sich alle Produktinfos zu holen.
OEM
Sie erhalten alle für Ihren User zugelassenen OEMs mit dazugehöriger Produkt-ID. Sie erhalten diese in 1000er Blöcken. Mit "page" können Sie diese durchgehen. Mehr infos hier
Beispiel
Bei Aufruf von:
https://ws.topdata.de/match/oem? uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
PCD
Sie erhalten alle für Ihren User zugelassenen PCDs mit dazugehöriger Produkt-ID. Sie erhalten diese in 1000er Blöcken. Mit "page" können Sie diese durchgehen. Mehr infos hier
Beispiel
Bei Aufruf von:
https://ws.topdata.de/match/pcd? uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
EAN
Sie erhalten alle für Ihren User zugelassenen EANs mit dazugehöriger Produkt-ID. Sie erhalten diese in 1000er Blöcken. Mit "page" können Sie diese durchgehen. Mehr infos hier
Beispiel
Bei Aufruf von:
https://ws.topdata.de/match/ean? uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
Lieferanten Artikel-Nr
Sie erhalten alle für Ihren User zugelassenen Lieferanten Artikel-Nr mit dazugehöriger Produkt-ID. Sie erhalten diese in 1000er Blöcken. Mit "page" können Sie diese durchgehen. Mehr infos hier
Beispiel
Bei Aufruf von:
https://ws.topdata.de/match/distributor? uid=%uid%& security_key=%security_key%& password=%password%& version=%version%& language=%language%
Code Beispiele
PHP
Z.B. für das Abrufen von einem Produkt.
<?php //receive data $data = file_get_contents('https://ws.topdata.de/product/145080?uid=...&security_key=...&password=..&version=100&language=de'); //decode json data $json = json_decode($data); //display json object var_dump($json); ?>