API Hilfe

Swagger/Open API Documentation

Authentifizierung

Zur Nutzung der API muss ein (kundenspezifisches) Token im Request Header übermittelt werden z.B:

"Authorization-Token: my-secret-token"

Komprimierung

Es wird dringend empfohlen, die Serverantwort auf Suchanfragen komprimiert zu empfangen, indem man ein

"Accept-Encoding: gzip,deflate"

im Request Header mitsendet.

Beispiele

Beispieleaufrufe API

Datenlieferung

Es besteht die Möglichkeit ihre Daten per Datei (FTP) und/oder über die API zu importieren. Wir empfehlen zunächst, insbesondere bei großen Datenmengen, einen vollständigen Import per Datei durchzuführen, und die Daten danach per API aktuell zu halten.

Items

API	Description
PUT Items/{channel}	Aktualisiert bzw. fügt die gegebenen Artikel hinzu. Vorhandene Artikel werden komplett überschrieben, nicht vorhandene werden hinzugefügt. Die Artikel müssen im Request Body als JSON übermittelt werden.
PUT Items/{channel}/Delete	Löscht die Artikel mit den angebenen Artikelnummern.

Conversion

API	Description
POST Analytics/Conversion?GoalId={GoalId}&AnalyticsCorrelationId={AnalyticsCorrelationId}&ConversionDate={ConversionDate}&Revenue={Revenue}&ItemNo={ItemNo}&ItemName={ItemName}	Erstellt eine Conversion für das Ziel mit der angegeben Id.

AutoComplete

API	Description
GET Autocomplete?Query={Query}&Top={Top}&GroupItemsByName={GroupItemsByName}&UseSuggestionOnEmptyResult={UseSuggestionOnEmptyResult}&ArtikelnameOrderBy={ArtikelnameOrderBy}&Channel={Channel}&ItemGroupSearchCount={ItemGroupSearchCount}&PortalKundeId={PortalKundeId}	No documentation available.

ContentPages

API	Description
POST ContentPages/{channelName}	Fügt dem Channel mit dem gegebenem Namen die übergebenen Content-Seiten hinzu. Evtl. vorhandene Seiten werden gelöscht.

Search

API	Description
GET Search?Query={Query}&Top={Top}&TopFacets={TopFacets}&Skip={Skip}&UseSuggestionOnEmptyResult={UseSuggestionOnEmptyResult}&OrderBy={OrderBy}&Filter={Filter}&Channel={Channel}&Facets={Facets}&MinMaxFacets={MinMaxFacets}&IncludeAdditonalAttributes={IncludeAdditonalAttributes}&GroupItemsByName={GroupItemsByName}&WithinGroupedItemsOrderBy={WithinGroupedItemsOrderBy}	No documentation available.