Webservice API/en: Unterschied zwischen den Versionen

Aus TopData WIKI
Wechseln zu: Navigation, Suche
(Die Seite wurde neu angelegt: „the productlist is returned 2 products(123456 and 789012). <h3>Product</h3> <p>Request one with the from filter allowed informations of the webservice. The pro…“)
 
(11 dazwischenliegende Versionen des gleichen Benutzers werden nicht angezeigt)
Zeile 37: Zeile 37:
 
<h3>API-Version</h3>
 
<h3>API-Version</h3>
 
If the web service is changed, then a new API version will be provided so that your own application does not always also need to be updated. ATTENTION: We can only provide support for the latest API version.
 
If the web service is changed, then a new API version will be provided so that your own application does not always also need to be updated. ATTENTION: We can only provide support for the latest API version.
−
* actual APIVersion: '''101'''
+
* actual APIVersion: '''110'''
 
<source lang="text">?version=103</source>
 
<source lang="text">?version=103</source>
 
<h3>Language</h3>
 
<h3>Language</h3>
Zeile 43: Zeile 43:
 
<source lang="text">?language=en</source>
 
<source lang="text">?language=en</source>
 
<h3>Error Codes</h3>
 
<h3>Error Codes</h3>
−
Overview of all errors:
+
Alle Fehler im Überblick
 
{| class="wikitable"
 
{| class="wikitable"
−
!Error Code!!Description
+
!Fehler Code!!Fehler Beschreibung
 
|-
 
|-
−
|''100''||unknown error
+
|''100''||Unbekannter Fehler
 
|-
 
|-
−
|''101''||404 – page not found
+
|''101''||404 - Seite nicht gefunden
 
|-
 
|-
−
|''102''||User ID not available or not valid
+
|''102''||User ID nicht vorhanden oder nicht valide
 
|-
 
|-
−
|''103''||safety code not available or not valid
+
|''103''||Sicherheitscode nicht vorhanden oder nicht valide
 
|-
 
|-
−
|''104''||password not available or not valid
+
|''104''||Passwort nicht vorhanden oder nicht valide
 
|-
 
|-
−
|''105''||API-Version not available or not valid
+
|''105''||API-Version nicht vorhanden oder nicht valide
 
|-
 
|-
−
|''106''||authentication failed
+
|''106''||Authentifizierung fehlgeschlagen
 
|-
 
|-
−
|''107''||language not available or not valid
+
|''107''||Sprache nicht vorhanden oder nicht valide
 
|-
 
|-
−
|''108''||template not found (please inform service)
+
|''108''||Template nicht gefunden (Bitte Service informieren)
 
|-
 
|-
−
|''109''||template error (please inform service)
+
|''109''||Template Fehler (Bitte Service informieren)
 
|-
 
|-
−
|''200''||product not found
+
|''110''||Filter nicht vorhanden oder nicht valide
 +
|-
 +
|''200''||Produkt nicht gefunden
 
|}
 
|}
  
Zeile 83: Zeile 85:
 
   version=%version%&
 
   version=%version%&
 
   language=%language%</source>
 
   language=%language%</source>
−
the product list is returned.
+
erhalten Sie die Produktliste als Rückgabe.
−
<h3> Product groups </h3>
+
<h4>My products only with articlenumber</h4>
−
<p> Accesses the complete product groups as a list::</p>
+
<p>You get all your products as [[Webservice_API#Produktliste|productlist]] that are activate for your account and where is a articlenumber of a distributor for.</p>
−
<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>
+
 
<source lang="text">http://ws.cloud.topdata.de/distributor_products</source>
 
<source lang="text">http://ws.cloud.topdata.de/distributor_products</source>
−
<h3>Warengruppen</h3>
+
<h3>Waregroups</h3>
−
<p>ruft die kompletten Warengruppen als Liste auf:</p>
+
<p>get the complete waregroups as list:</p>
 
<source lang="text">http://ws.cloud.topdata.de/waregroups</source>
 
<source lang="text">http://ws.cloud.topdata.de/waregroups</source>
 
<p>''' Example: '''</p>
 
<p>''' Example: '''</p>
Zeile 135: Zeile 135:
 
the product list is returned
 
the product list is returned
  
−
<h3>Productlist</h3>
+
<h3>Produktliste</h3>
−
<p>Die The product list includes all information about the products and is returned when certain web services are accessed.</p>
+
<p>Die Produktliste enthält alle vom Filter zugelassenen Informationen zu den Produkten und wird bei bestimmten Webservice-Aufrufen zurückgegeben. Es gelten die selben [[Webservice_API#Filter|Filterangaben wie beim Produkt]]</p>
−
* [[Webservice_API#Warengruppen|waregroup_products]]
+
* [[Webservice_API#Warengruppen|Warengruppen Produkte]]
 
* [[Webservice_API#bundle_content|''bundle_content'']]  
 
* [[Webservice_API#bundle_content|''bundle_content'']]  
 
* [[Webservice_API#product_alternates|''product_alternates'']]  
 
* [[Webservice_API#product_alternates|''product_alternates'']]  
Zeile 143: Zeile 143:
 
* [[Webservice_API#product_accessories|''product_accessories'']]  
 
* [[Webservice_API#product_accessories|''product_accessories'']]  
 
* [[Webservice_API#product_application_in|''product_application_in'']]
 
* [[Webservice_API#product_application_in|''product_application_in'']]
−
* [[Webservice_API#Anbieter Produkte|provider_products]]
+
* [[Webservice_API#Anbieter Produkte|Anbieter Produkte]]
−
<p>'''Example'''</p>
+
<p>'''Beispiel'''</p>
 
<source lang="javascript">
 
<source lang="javascript">
 
{
 
{
Zeile 159: Zeile 159:
 
}
 
}
 
</source>
 
</source>
−
<p>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:</p>
+
<p> In order to keep traffic and loading times low, the product list is always divided into multiple pages. The individual pages may be accessed via an additional HTTP request variable:</p>
 
<source lang="text">?page=3</source>
 
<source lang="text">?page=3</source>
−
<p>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.<br>
+
<p> The product list includes information about the number of pages, the number of products, the number of products per page, and the currently selected sub-page.
−
Die Produkte in der Produktliste werden analog zum Aufruf eines einzelnen Produktes dargestellt.
+
The products in the product list are displayed analogously to how individual products are accessed.
 
</p>
 
</p>
−
<p>'''mehrere Produkte auf einmal abrufen (ab Version 103)'''</p>
+
<p>'''more products for one request (since version 103)'''</p>
−
<p>Sie können auch einer Webservice Abfrage mehrere Produkt-IDs übergeben um dazu die Produktliste zu erhalten.
+
<p>You can give the webservice more than one products id to get a productlist for this.
−
Diese werden per Komma getrennten String übergeben. ACHTUNG es sind maxmimal 50 Produkt-IDs zugelassen (mehr werden ignoriert).
+
Provide the products ids comma seperated in a string. Attention only maximal 50 Product-IDs are allowed(more of this will be ignored).
 
</p>
 
</p>
 
<source lang="text">http://ws.cloud.topdata.de/product_list</source>
 
<source lang="text">http://ws.cloud.topdata.de/product_list</source>
Zeile 312: Zeile 312:
 
<p>By the [[Webservice_API#Produktliste|Productlist]] the products will be transfered in the same way<br /><br /></p>
 
<p>By the [[Webservice_API#Produktliste|Productlist]] the products will be transfered in the same way<br /><br /></p>
 
<h4>Filter</h4>
 
<h4>Filter</h4>
−
<p>ab Verion 103 pflicht</p>
+
<p>since Verion 103 required</p>
−
<p>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.</p>
+
<p>The product features can be filtered to minimize the JSON return of the webservice. If not all the information are needed, with teh correct filtering the converting from JSON to an object can save a lot of time in your application.</p>
 
* Filter (%filter%)
 
* Filter (%filter%)
 
<source lang="text">?filter=all</source>
 
<source lang="text">?filter=all</source>
−
<p>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.
+
<p>The following basic filter available "all". This is in principle given back everything. If you do not need anything, you can use different filters in the table below.
−
Diese lassen sich auch kombiniert übergeben mit komma getrennt.</p>
+
This can also be passed separately combined with comma.</p>
 
<source lang="text">?filter=specifications,product_alternates</source>
 
<source lang="text">?filter=specifications,product_alternates</source>
 
{| class="wikitable"
 
{| class="wikitable"
−
|+ Legende uneindeutiger Variablen und Filterangaben
+
|+ Legend of unclear variables and filter values
−
!Variable!!Beschreibung!!Filterkeys
+
!Variable!!Description!!Filter
 
|-
 
|-
−
|''reference_oems''||Falls das Produkt eine Alternative ist, kommen hier die OEMs zu den entsprechenden Produkten||
+
|''reference_oems''||If the product is an alternative, then the OEMs for the corresponding products appear here
 
|-
 
|-
−
|''bundle_content_oems''||Falls das Produkt ein Bundle ist, kommen hier die OEMs der Einzelprodukte||
+
|''bundle_content_oems''|| If the product is a bundle, then the OEMs for the individual products appear here
 +
 
 
|-
 
|-
−
|''waregroups''||Warengruppen zum Produktes||waregroups
+
|''waregroups''||Waregroups for the product||waregroups
 
|-
 
|-
−
|''specifications''||Spezifikationen des Produktes||specifications
+
|''specifications''||specifications for the product||specifications
 
|-
 
|-
−
|''images''||Bilder zum Produkt||images
+
|''images''||Images for the product||images
 
|-
 
|-
−
|[[Webservice_API#bundle_content|''bundle_content'']]||Falls das Produkt ein Bundle ist, kommen hier die Produkt IDs der Einzelprodukte||bundle_content
+
|[[Webservice_API#bundle_content|''bundle_content'']]||Falls If the product is a bundle, then the product IDs for the individual products appear here||bundle_content
 +
 
 
|-
 
|-
−
|[[Webservice_API#product_alternates|''product_alternates'']]||Alternative Produkt IDs zum Produkt||product_alternates
+
|[[Webservice_API#product_alternates|''product_alternates'']]|| Alternative product IDs for the product||product_alternates
 +
 
 
|-
 
|-
−
|[[Webservice_API#product_is_alternate_of|''product_is_alternate_of'']]||Produkt ist eine Alternative der genannten Produkt IDs||product_is_alternate_of
+
|[[Webservice_API#product_is_alternate_of|''product_is_alternate_of'']]|| The product is an alternative of the product IDs indicated||product_is_alternate_of
 
|-
 
|-
−
|[[Webservice_API#product_accessories|''product_accessories'']]||Zubehör Produkt IDs zum Produkt||product_accessories
+
|[[Webservice_API#product_accessories|''product_accessories'']]||Zubehör Accessory product IDs for the product||product_accessories
 
|-
 
|-
−
|[[Webservice_API#product_same_accessories|''product_same_accessories'']]||Alle Produkt IDs mit dem selben Zubehör zum Produkt||product_same_accessories
+
|[[Webservice_API#product_same_accessories|''product_same_accessories'']]|| All product IDs with the same accessories for the product||product_same_accessories
 
|-
 
|-
−
|[[Webservice_API#product_application_in|''product_application_in'']]||Produkt ist Zubehör von den genannten Produkt IDs||product_application_in
+
|[[Webservice_API#product_application_in|''product_application_in'']]|| Product is an accessory of the named product IDs||product_application_in
 
|-
 
|-
−
|[[Webservice_API#product_same_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
+
|[[Webservice_API#product_same_application_in|''product_same_application_in'']]|| All product IDs with the same parent product which are an accessory for the product||product_same_application_in
 
|-
 
|-
−
|''child_extra_infos''||Grundinfos zu den Verknüpften Produkten (Hersteller, Produktname und Kurzbeschreibung) (ab Verion 102)||child_extra_infos
+
|''child_extra_infos''||Basic infos for the crossesproducts (manufacturer, name and shortdescription) (since version 102)||child_extra_infos
 
|-
 
|-
−
|''distributors''||verfügbare Anbieter und deren Artikelnummern
+
|''distributors''|| available providers and their article numbers||
−
|}<br>
+
|}<br />
 
{| class="wikitable"
 
{| class="wikitable"
−
|+ Zugangseinschränkungen
+
|+ Access limitations:
−
!Variable!!Beschreibung
+
 
 +
!Variable!!Description
 
|-
 
|-
−
|''images''||Bilder erhalten Sie nur dann, wenn diese für Ihren Zugang aktiviert wurden
+
|''images''|| You will only receive images if these are activated for your access details
 
|-
 
|-
−
|''distributors''||Sie erhalten jeweils nur die Lieferanten, die für Ihren Zugang aktiviert wurden
+
|''distributors''|| You will only receive suppliers that are activated for your access details
 
|}
 
|}
  
Zeile 549: Zeile 553:
 
<p>After choose a Printer-model you can receive the matching supplies over [[Webservice_API#product_accessories|product_accessories]].</p>
 
<p>After choose a Printer-model you can receive the matching supplies over [[Webservice_API#product_accessories|product_accessories]].</p>
 
<h3>Mapping</h3>
 
<h3>Mapping</h3>
−
<p>Nutzen Sie das Mapping um schnell unseren Produktbestand mit Ihrem abzugeleichen. So ist es nicht nötig sich alle Produktinfos zu holen.</p>
+
<p>Use the mapping to match quickly your product portfolio with our product portfolio. So it is not necessary to get all the info.</p>
 
<h4>OEM</h4>
 
<h4>OEM</h4>
−
<p>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 [[Webservice_API#Produktliste|hier]] </p>
+
<p>You get all for your user available OEM with our product ID. This comes in 1000er blocks. With "page" you can go through it. More infos [[Webservice_API#Produktliste|hear]] </p>
−
<p>'''Beispiel'''</p>
+
<p>'''Example'''</p>
−
Bei Aufruf von:
+
By accessing:
 
<source lang="text">http://ws.cloud.topdata.de/match/oem?
 
<source lang="text">http://ws.cloud.topdata.de/match/oem?
 
   uid=%uid%&
 
   uid=%uid%&
Zeile 561: Zeile 565:
 
   language=%language%</source>
 
   language=%language%</source>
 
<h4>PCD</h4>
 
<h4>PCD</h4>
−
<p>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 [[Webservice_API#Produktliste|hier]] </p>
+
<p>You get all for your user available PCD with our product ID. This comes in 1000er blocks. With "page" you can go through it. More infos [[Webservice_API#Produktliste|hear]] </p>
−
<p>'''Beispiel'''</p>
+
<p>'''Example'''</p>
−
Bei Aufruf von:
+
By accessing:
 
<source lang="text">http://ws.cloud.topdata.de/match/pcd?
 
<source lang="text">http://ws.cloud.topdata.de/match/pcd?
 
   uid=%uid%&
 
   uid=%uid%&
Zeile 571: Zeile 575:
 
   language=%language%</source>
 
   language=%language%</source>
 
<h4>EAN</h4>
 
<h4>EAN</h4>
−
<p>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 [[Webservice_API#Produktliste|hier]] </p>
+
<p>You get all for your user available EAN with our product ID. This comes in 1000er blocks. With "page" you can go through it. More infos [[Webservice_API#Produktliste|hear]] </p>
−
<p>'''Beispiel'''</p>
+
<p>'''Example'''</p>
−
Bei Aufruf von:
+
By accessing:
 
<source lang="text">http://ws.cloud.topdata.de/match/ean?
 
<source lang="text">http://ws.cloud.topdata.de/match/ean?
 
   uid=%uid%&
 
   uid=%uid%&
Zeile 580: Zeile 584:
 
   version=%version%&
 
   version=%version%&
 
   language=%language%</source>
 
   language=%language%</source>
−
<h4>Lieferanten Artikel-Nr</h4>
+
<h4>Distributor articlenumber</h4>
−
<p>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 [[Webservice_API#Produktliste|hier]] </p>
+
<p>You get all for your user available Distributor articlenumber with our product ID. This comes in 1000er blocks. With "page" you can go through it. More infos [[Webservice_API#Produktliste|hear]] </p>
−
<p>'''Beispiel'''</p>
+
<p>'''Example'''</p>
−
Bei Aufruf von:
+
By accessing:
 
<source lang="text">http://ws.cloud.topdata.de/match/distributor?
 
<source lang="text">http://ws.cloud.topdata.de/match/distributor?
 
   uid=%uid%&
 
   uid=%uid%&

Aktuelle Version vom 1. Dezember 2020, 09:06 Uhr

Sprachen:
Deutsch • ‎English


Webservice Api Basics

Use

By accessing our web service, you automatically declare that you understand and accept our web service use conditions.

Access is logged and evaluated. To save access/bandwidth and server capacity, we recommend minimising queries to the web service via data caching (if possible). We reserve the right to limit access or even to block it if access to the web service exceeds a plausible level.
Access data may not be provided to third parties or displayed publicly. Certain previously agreed data is approved for use as your access details.

Data format:

The web service is returned in the JSON format. We have decided against XML because JSON is currently equally as popular and reduces overhead compared with XML. More Information

Character encoding

data from the web services is released UFT8

Access

The web service data is accessed via a fixed HTTP URL 

http://ws.cloud.topdata.de

Access data is required to access the web service, which is comprised as follows:

  • User ID (%uid%)
  • Passwort (%password%)
  • Sicherheitscode (%security_key%)
The access data must be transferred as an HTTP request each time the web service is accessed. 

?uid=%uid%&security_key=%security_key%&password=%password%

The following HTTP request variables are required to receive a response from the web service. 

?uid=%uid%&security_key=%security_key%&password=%password%&version=%version%&language=%language%

API-Version

If the web service is changed, then a new API version will be provided so that your own application does not always also need to be updated. ATTENTION: We can only provide support for the latest API version.

  • actual APIVersion: 110 
?version=103

Language

The language must be provided as per ISO 639-1 

?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 functions

My products

Sie You will receive all products activated for your access details in the form of a product list.

http://ws.cloud.topdata.de/my_products

Example:

When accessing: 

http://ws.cloud.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.

My products only with articlenumber

You get all your products as productlist that are activate for your account and where is a articlenumber of a distributor for.

http://ws.cloud.topdata.de/distributor_products

Waregroups

get the complete waregroups as list:

http://ws.cloud.topdata.de/waregroups

Example:

When accessing: 

http://ws.cloud.topdata.de/waregroups?
  filter=%filter%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

you receive the following JSON output: 

{
    "waregroups": [
        {
            "waregroup_id": 1,
            "parent_waregroup_id": 173,
            "waregroup": "Printmedien"
        },
        {
            "waregroup_id": 3,
            "parent_waregroup_id": 162,
            "waregroup": "Etiketten"
        },
        ...
    ]
}

Products

Accesses all products contained in a specific product group. These are output as a Productlist. The product groups ID is required for this. This is can be obtained for example, by accessing the produktgroups or it is stored with one of the products

  • Warengruppen ID (%waregroup_id%) 
http://ws.cloud.topdata.de/waregroup/%warengroup_id%

'Example

When accessing 

http://ws.cloud.topdata.de/waregroup/%warengroup_id%?
  filter=%filter%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

the product list is returned

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

Beispiel

{
 
    "page": {
        "count_products": 694,
        "products_per_page": 50,
        "page": 1,
        "available_pages": 14
    },
    "products": [
        ...
    ]
}

In order to keep traffic and loading times low, the product list is always divided into multiple pages. The individual pages may be accessed via an additional HTTP request variable:

?page=3

The product list includes information about the number of pages, the number of products, the number of products per page, and the currently selected sub-page. The products in the product list are displayed analogously to how individual products are accessed.

more products for one request (since version 103)

You can give the webservice more than one products id to get a productlist for this. Provide the products ids comma seperated in a string. Attention only maximal 50 Product-IDs are allowed(more of this will be ignored). 

http://ws.cloud.topdata.de/product_list

Example

By accessing: 

http://ws.cloud.topdata.de/product_list?products=123456,789012&
  filter=%filter%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

the productlist is returned 2 products(123456 and 789012).

Product

Request one with the from filter allowed informations of the webservice. The product ID is required for this

  • Produkt ID (%products_id%)
  • Filter (%filter%) 
http://ws.cloud.topdata.de/product

Example für den Artikel 92298A von HP

By accessing: 

http://ws.cloud.topdata.de/product/145080?filter=all&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

you receive the following JSON output: 

{
    "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": [ ]
    }
}

By the Productlist the products will be transfered in the same way

Filter

since Verion 103 required

The product features can be filtered to minimize the JSON return of the webservice. If not all the information are needed, with teh correct filtering the converting from JSON to an object can save a lot of time in your application.

  • Filter (%filter%) 
?filter=all

The following basic filter available "all". This is in principle given back everything. If you do not need anything, you can use different filters in the table below. This can also be passed separately combined with comma.

?filter=specifications,product_alternates
Legend of unclear variables and filter values
Variable Description Filter
reference_oems If the product is an alternative, then the OEMs for the corresponding products appear here
bundle_content_oems If the product is a bundle, then the OEMs for the individual products appear here
waregroups Waregroups for the product waregroups
specifications specifications for the product specifications
images Images for the product images
bundle_content Falls If the product is a bundle, then the product IDs for the individual products appear here bundle_content
product_alternates Alternative product IDs for the product product_alternates
product_is_alternate_of The product is an alternative of the product IDs indicated product_is_alternate_of
product_accessories Zubehör Accessory product IDs for the product product_accessories
product_same_accessories All product IDs with the same accessories for the product product_same_accessories
product_application_in Product is an accessory of the named product IDs product_application_in
product_same_application_in All product IDs with the same parent product which are an accessory for the product product_same_application_in
child_extra_infos Basic infos for the crossesproducts (manufacturer, name and shortdescription) (since version 102) child_extra_infos
distributors available providers and their article numbers

Access limitations:
Variable Description
images You will only receive images if these are activated for your access details
distributors You will only receive suppliers that are activated for your access details

bundle_content

Accesses the products contained for a certain bundle product. These are output as a Productlist . The product ID of the bundle is required for this.

  • Produkt ID (%product_id%) 
http://ws.cloud.topdata.de/bundle_content/%product_id%

Example

By accessing: 

http://ws.cloud.topdata.de/bundle_content/%product_id%?
  filter=%filter%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

the product list is returned.

product_alternates

Accesses the alternative product for a certain product. These are output as a Productlist . The product ID of the bundle is required for this.

  • Produkt ID (%product_id%) 
http://ws.cloud.topdata.de/product_alternates/%product_id%

Example

By accessing: 

http://ws.cloud.topdata.de/product_alternates/%product_id%?
  filter=%filter%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

the product list is returned.

product_is_alternate_of

For a certain alternative product, accesses those products for which it is an alternative.These are output as a Productlist . The product ID of the bundle is required for this.

  • Produkt ID (%product_id%) 
http://ws.cloud.topdata.de/product_is_alternate_of/%product_id%

'Example

Bay accessing: 

http://ws.cloud.topdata.de/product_is_alternate_of/%product_id%?
  filter=%filter%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

the product list is returned.

product_accessories

Accesses those products which are an accessory. These are output as a Productlist . The product ID of the bundle is required for this.

  • Produkt ID (%product_id%) 
http://ws.cloud.topdata.de/product_accessories/%product_id%

Example

By accessing 

http://ws.cloud.topdata.de/product_accessories/%product_id%?
  filter=%filter%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

the product list is returned.

product_same_accessories

Accesses those products for a certain product, which are having the same accessories. These are output as a Productlist . The product ID of the bundle is required for this

  • Produkt ID (%product_id%) 
http://ws.cloud.topdata.de/product_same_accessories/%product_id%

Example

By accessing 

http://ws.cloud.topdata.de/product_same_accessories/%product_id%?
  filter=%filter%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

the product list is returned.

product_application_in

Accesses those products for which it is an accessory. These are output as a Productlist . The product ID of the bundle is required for this.

  • Produkt ID (%product_id%) 
http://ws.cloud.topdata.de/product_application_in/%product_id%

Example

By accessing: 

http://ws.cloud.topdata.de/product_application_in/%product_id%?
  filter=%filter%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

the product list is returned.

product_same_application_in

Accesses those products which are also an accessory. These are output as a Productlist . The product ID of the bundle is required for this.

  • Produkt ID (%product_id%) 
http://ws.cloud.topdata.de/product_same_application_in/%product_id%

Example

By accessing 

http://ws.cloud.topdata.de/product_same_application_in/%product_id%?
  filter=%filter%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

the product list is returned.

Provider products

Accesses the products for a certain provider. These are output as a Productlist . The product ID of the bundle is required for this.

  • Anbieter ID (%distributor_id%) 
http://ws.cloud.topdata.de/distributor/%distributor_id%

Example

By accessing: 

http://ws.cloud.topdata.de/distributor/%distributor_id%?
  filter=%filter%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

Productfinder

Here you get the data ready to use it as productfinder.

Ink and Toner Finder

The Ink and Toner Finder needs to find the matching consumables for your printer in 2-3 steps.

  • Printer-Brand (Required) Step 1
  • Printer-Modelseries (Optional) Step 2
  • Printer-Types (Optional) Step 2
  • Printer-Model (Required) Step 3
  • Printer-Model Textsearch

Printer-Brand

By accessing: 

http://ws.cloud.topdata.de/finder/ink_toner/brands?
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

you get the Printer-Brands as Request.

Printer-Modelseries

By accessing:

  • Printer-Brand ID is required (%brand_id%) 
http://ws.cloud.topdata.de/finder/ink_toner/modelseries?
  brand_id=%brand_id%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

you get the Printer-Modelseries as Request.

Printer-Types

By accessing:

  • Printer-Brand ID is required (%brand_id%) 
http://ws.cloud.topdata.de/finder/ink_toner/devicetypes?
  brand_id=%brand_id%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

you get the Printer-Types as Request.

Printer-Models

By accessing:

  • Printer-Brand ID is required (%brand_id%)
  • Printer-Modelserie ID is optional (%modelserie_id%)
  • Printer-Type ID is optional (%devicetype_id%) 
http://ws.cloud.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%

you get the Printer-Models as Request.

After choose a Printer-model you can receive the matching supplies over product_accessories.

Printer-Model Textsearch

By accessing:

  • Searchkeyword is required (%q%) 
http://ws.cloud.topdata.de/finder/ink_toner/search?
  q=%q%&
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

you get the Printer-Models as Request.

After choose a Printer-model you can receive the matching supplies over product_accessories.

Mapping

Use the mapping to match quickly your product portfolio with our product portfolio. So it is not necessary to get all the info.

OEM

You get all for your user available OEM with our product ID. This comes in 1000er blocks. With "page" you can go through it. More infos hear

Example

By accessing: 

http://ws.cloud.topdata.de/match/oem?
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

PCD

You get all for your user available PCD with our product ID. This comes in 1000er blocks. With "page" you can go through it. More infos hear

Example

By accessing: 

http://ws.cloud.topdata.de/match/pcd?
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

EAN

You get all for your user available EAN with our product ID. This comes in 1000er blocks. With "page" you can go through it. More infos hear

Example

By accessing: 

http://ws.cloud.topdata.de/match/ean?
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

Distributor articlenumber

You get all for your user available Distributor articlenumber with our product ID. This comes in 1000er blocks. With "page" you can go through it. More infos hear

Example

By accessing: 

http://ws.cloud.topdata.de/match/distributor?
  uid=%uid%&
  security_key=%security_key%&
  password=%password%&
  version=%version%&
  language=%language%

Code Example

PHP

Example to receive one product. 

<?php
 
	//receive data
	$data = file_get_contents('http://ws.cloud.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);
 
?>
Von „http://wiki.cloud.topdata.de/index.php?title=Webservice_API/en&oldid=385“