Shopping-API nutzen

Sie können nicht nur unsere Werbemittel in Website integrieren, Ecato stellt auch eine Entwickler-Schnittstelle (API) zur Verfügung mit der individuelle Anwendungen umgesetzt werden können. Nachfolgend finden Sie die Dokumentation zur Nutzung der Shopping-API für Ihre Anwendung.

Allgemein

Die Schnittstelle wird nach dem REST-Standard über HTTP-GET aufgerufen. Als Rückgabeformate stehen JSON und XML zur Auswahl. Die Authentifizierung findet über einen Anwendungsschlüssel, der nach der Anmeldung erzeugt wird, und die Nummer der Website, für die diese Anwendung genutzt wird, statt.

  • Basis-URL: http://prom.ecato.net/
  • Parameter
    • format – Auswahl, optional, Rückgabeformat “json” (Standard) oder “xml”
    • application_key – Zeichenkette, notwendig, Schlüssel der Anwendung
    • website_id – Ganzzahl, notwendig, Identifikation der Partner-Website
    • callback – Zeichenkette, optional, Rückgabe als gewünschte JSON-Funktion für domainübergreifenden, direkten Zugriff (JSONP)

Beispiel-URL:
http://prom.ecato.net/?format=xml&application_key=123abc456def789ghi&website_id=12345

Beispielergebnis:
- <result>
 + <category>
 + <breadcrumb>
 + <subcategories>
 + <top_products>
 </result>

Das API-Ergebnis ist UTF-8 kodiert und enthält auch API-URLs , die Sie zu weiterführenden Anfragen führen. Jede Anfrage darf maximal 15 Minuten in einem Cache zwischengespeichert werden.

Anfragen

Selbstverständlich können Sie über die API auch konkrete Kategorien, Suchergebnisse und Produktdetails abfragen.

Kategorieanfrage
Der allgemeine API-Aufruf, siehe oben, liefert das Ergebnis für die Startseite zurück. Dieses ist wie das Rückgabeergebnis der Kategorien aufgebaut, die Unterkategorien enthalten. Sind keine Unterkategorien mehr vorhanden, enthält das API-Ergebnis die Liste der Produkte in einer Kategorie.

  • Parameter
    • category_id, Ganzzahl, notwendig, Kategorienummer
    • filter_id, Liste, optional, Filternummer zur Einschränkung der Produktliste
    • search, Zeichenkette (UTF-8), optional, Suchworte zur Filterung der Produktliste
    • searchmode, Auswahl, optional, Suchmodus any (Standard), all oder phrase
    • limit, Ganzzahl, optional, maximale Anzahl der Produkte je Seite, z.B. 10 (Standard)
    • order, Auswahl, optional, Sortierung der Produktliste nach rank (Standard), vd (Stimmenanzahl absteigend), pa (Preis aufsteigend), pdd (Preisdifferenz absteigend), rd (Bewertung absteigend)
    • page, Ganzzahl, optional, Angabe der Seitennummer, z.B. 1 (Standard)
    • top_product_limit, Ganzzahl, optional, maximale Anzahl der Top-Produkte, z.B. 10 (Standard)
    • top_offer_limit, Ganzzahl, optional, maximale Anzahl der Top-Angebote je Produkt, z.B. 1 (Standard)
    • top_offer_order, optional, Sortierung der Top-Angebote nach rank (Standard), na (Name aufsteigend) oder pa (Gesamtpreis aufsteigend)
    • top_shop_offer_limit, Auswahl, optional, nur je Produkt ein Top-Angebot eines Top-Shops, 1 oder -1 (Standard) für keine Beschränkung
  • Ergebnis – filterbar über Parameter result_type mit Komma getrennt (Standard: alle)
    • category – Kategorieinformationen, siehe Ergebnistyp “category”
    • breadcrumb – Brotkrumenpfad, siehe Ergebnistyp “breadcrumb”
    • filters – Produktfilter, sofern Produkte vorhanden, siehe Ergebnistyp “filters”
    • subcategories – Unterkategorien, siehe Ergebnistyp “subcategories”
    • top_products – Top-Produkte, siehe Ergebnistyp “top_products”
    • products- Produktliste, sofern Produkte vorhanden, siehe Ergebnistyp “products”
    • page_cnt – Anzahl der verfügbaren Seiten (nicht filterbar)
    • tracking_code – Tracking-Code für Ecato-Reporting (nicht filterbar), Ausgabepflicht

Produktdetailseite
Im API-Ergebnis zu Kategorien sind ggf. Produktlisten enthalten, die jeweils auf die Produktdetails verweisen. Nach Angabe einer Produkt-Nummer erhält man alle relevanten Informationen sowie Angebote, Meinungen und Testberiche zum Produkt.

  • Parameter
    • product_id, Zeichenkette, notwendig, Produkt-Nummer
    • limit, Ganzzahl, optional, Maximale Anzahl der Angebote, Kommentare und Testberichte zum Produkt
    • offer_limit, Ganzzahl, optional, Maximale Anzahl der Angebote im Preisvergleich, z.B. 3 (Standard)
    • comment_limit, Ganzzahl, optional, Maximale Anzahl der Meinungen, z.B. 3 (Standard)
    • review_limit, Ganzzahl, optional, Maximale Anzahl der Testberichte, z.B. 3 (Standard)
  • Ergebnis – filterbar über Parameter result_type mit Komma getrennt (Standard: alle)
    • breadcrumb – Brotkrumenpfad, siehe Ergebnistyp “breadcrumb”
    • product – Produktdaten ggf. inkl. Top-Angebote, siehe Ergebnistyp “product”
    • offers – Angebotsliste, siehe Ergebnistyp “offers”
    • comments – Meinungen, siehe Ergebnistyp “comments”
    • reviews – Testberichte, siehe Ergebnistyp “reviews”
    • tracking_code – Tracking-Code für Ecato-Reporting (nicht filterbar), Ausgabepflicht

Ergebnistypen

Unsere Shopping-API gibt eine Vielfalt an Informationen zurück, die in verschiedene Ergbnistypen gegliedert sind. Alle fett gedruckten Ergebnistypen sind über den Parameter result_type mit Komma getrennt filterbar.

  • category – Meta-Informationen zur Kategorie
    • category_id – Kategorie-Nummer
    • name – Name der Kategorie
    • product_cnt – Anzahl der Produkte dieser Kategorie
    • description – Beschreibung, die im Kundenbereich zur Kategorie eingestellt wurde (noch nicht verfügbar)
    • keywords – Stichworte, die im Kundenbereich zur Kategorie eingestellt wurden (noch nicht verfügbar)
  • breadcrumb – Krümelpfad zur aktuellen Seite
    • category_id – Kategorie-Nummer
    • name – Name der Kategorie
  • subcategories – Liste mit Unterkategorien
    • category_id – Kategorie-Nummer
    • name – Name der Kategorie
    • subcategory_cnt – Anzahl der Unterkategorien, wenn “0” folgt Produktliste
    • api_url – API-URL zur entsprechenden Kategorieseite
  • filters – Liste mit Filtern für die Einschränkung der Produktliste
    • name – Name des Filters
    • values – Werte zum jeweiligen Filter
      • name – Name des Filter-Wertes
      • filter_id – Nummer des Filters
      • product_cnt – Anzahl der Produkte mit diesem Filter-Wert
      • api_url – API-URL zur Kategorieseite mit jeweiligem Filter
  • top_products – Top-Produkte der aktuellen Kategorie, enthält je item Produkt-Informationen, siehe Rückgabetyp “products”
  • products – Liste mit Produkten der jeweiligen Kategorie unter Berücksichtigung von Suchworten und Filtern
    • product_id – Produktnummer
    • brand – Markenname
    • name – Produktname
    • ean/pzn – globale Produktkennzeichnung
    • offer_cnt – Anzahl der Händler-Angebote
    • shop_cnt – Anzahl der Händler, die diesen Artikel anbieten
    • price_min – niedrigster Angebotspreis, ohne Versandkosten
    • price_max – höchster Angebotspreis, ohne Versandkosten
    • price_diff_pct – prozentuales Ersparnis vom niedrigsten Angebotspreis gegenüber dem höchsten Angebotspreis, ohne Versandkosten
    • rating_pct – prozentuales Anteil positiver Produktbewertungen aus Meinungen und Testberichten
    • vote_cnt – Anzahl der abgegebenen Stimmen
    • comment_cnt – Anzahl der Meinungen
    • review_cnt – Anzahl der Kommentare
    • attributes – Liste mit Produkteigenschaften
    • top_offers – Liste der Top-Angebote, je item Daten des Angebots, siehe Ergebnistyp “offers”
    • api_url – API-URL zur Produktdetailseite
  • offers – Liste mit Händlerangeboten zu einem Produkt
    • brand – Angebotsmarke
    • name – Angebotsname
    • price – Angebotspreis
    • price_shipping – günstigste mögliche Versandkosten, Ausgabepflicht, wenn vorhanden
    • price_total – Gesamtpreis inklusive Versandkosten
    • price_base – Grundpreis, Ausgabepflicht, wenn vorhanden
    • legal_notice – Rechtlicher Hinweis (z.B. bei Vertragsangeboten), Ausgabepflicht, wenn vorhanden
    • shop – Name des Shops
    • shop_logo_url – Bild-URL zum Shop-Logo, wenn vorhanden
    • update_unixtime – Datum der letzten Angebotsüberprüfung im Unixformat
    • update_datetime – Datum der letzten Angebotsüberprüfung in deutscher Formatierung, Ausgabepflicht, wenn nicht über update_unixtime
    • image_url_55x55 – Bild-URL zum Produktfoto mit maximal 55×55 Bildpunkten
    • image_url_70x70 – Bild-URL zum Produktfoto mit maximal 70×70 Bildpunkten
    • image_url_100x100 – Bild-URL zum Produktfoto mit maximal 100×100 Bildpunkten
    • image_url_200x200 – Bild-URL zum Produktfoto mit maximal 200×200 Bildpunkten
    • shop_offer_url – Link zum Angebot im Online-Shop (inkl. Ecato-Tracking)
  • comments/reviews – Meinungen bzw. Testberichte zu einem Produkt
    • comment_id/review_id – Meinungs-/Testbericht-Nummer
    • author – Name des Autors
    • author_image_url – Bild-URL zum Autorenfoto oder Magazin-Logo
    • url – URL zur Autorenwebseite bzw. zum vollständigen Testbericht
    • text – Meinungstext bzw. Testberichtfazit (ggf. gekürzt)
    • datetime – Verfassungsdatum
    • rating – Produktbewertung “negativ”, “neutral” oder “positiv”

Weiter zum nächsten Schritt

Lesen Sie nachfolgend wie Sie fortfahren können.
» Anwendungen anmelden

Sie haben Fragen?

Wir helfen Ihnen gern per Email an weiter!

Die Kommentarfunktion ist geschlossen.