Import Schnittstelle

Mit den hier beschriebenen REST-Schnittstellen können Sie Inhalte mithilfe von POST- und GET-Anfragen in OXOMI importieren und löschen.

Um Dateien an die Schnittstellen zu übermitteln, senden Sie diese im Body der POST-Anfrage.

Authentifizierung

Der Token für den Zugriff auf die Schnittstellen ist folgendermaßen zu berechnen:

token = md5(api-token + timeStamp)

Auf den Profilen der Nutzer unter /admins finden Sie unter "API-Token" den aktuellen API-Token des Nutzers. Um zu prüfen ob Ihre Berechnung korrekt ist können Sie Ihr Ergebnis mit dem Feld "Aktuelles Berechtigungstoken" vergleichen.

Der timeStamp ist ein UNIX-Timestamp auf ganze Tage gerundet. Der Timestamp in Sekunden wird ganzzahlig durch 86400 (Anzahl der Sekunden pro Tag) dividiert. Das Umrechnen auf ganze Tage sorgt dafür, dass eine Anfrage effektiv einen Tag gültig bleibt.

Der MD5-Hash ist von dem String "api-token + timeStamp" im UTF-8 Encoding zu berechnen.

Beispiel mit Java und der "Hashing"-Klasse aus der Bibliothek Google Guava:

String hash = Hashing.md5()
                     .newHasher()
                     .putString(apiToken, Charsets.UTF_8)
                     .putString(Long.toString(TimeUnit.MILLISECONDS.toDays(System.currentTimeMillis())), Charsets.UTF_8)
                     .hash()
                     .toString();

Dokument importieren

URL	/import/catalog
Typ	POST

Pflichtparameter

Parameter	Beispiel	Beschreibung
user	nutzer	Benutzername des für den Import zu nutzenden OXOMI-Anwenders.
token	ABC123	MD5 Hash aus dem API-Token des für den Import zu nutzenden OXOMI-Anwenders und dem aktuellen Tageszeitstempel.
filename	katalog.pdf	PDF-Dateiname des zu importierenden Dokuments (wird für die Suche nach bestehendem Dokument genutzt).
publicName	Preisliste 2019	Bestimmt den in OXOMI angezeigten Namen für das Dokument.
targetLevel	WHOLESALE	Bestimmt die Handelsstufe, für die das Dokument sichtbar sein soll. `WHOLESALE` für Großhandel,`RETAIL` für Einzelhandel, `END_CUSTOMER` für Endkunden.
forwarding	false	Gibt an, ob das Dokument an Partner weitergegeben werden soll. Mögliche Werte: `true`/`false`

Optionale Parameter

Parameter	Beispiel	Beschreibung
internalName	1_Preisliste_XYZ	Sollten Sie zwei Bezeichnungen für ein Dokument verwenden wollen, definieren Sie mit diesem Parameter die nur intern sichtbare Bezeichnung. Der Parameter publicName wird dann zur veröffentlichten Bezeichnung.
code	AktuellePreisliste	Ergänzend zur ID des Dokuments können Sie hier einen Code vergeben, über den Sie das Element gezielt ansprechen können.
catalogType	pricelist	Definiert den Dokument-Typ. Mögliche Typen und die zu verwendenden Codes finden Sie hier .
category	KATEGORIE_ID	Definiert eine Kategorie für das synchronisierte Dokument. Diese muss in OXOMI hier vorher bereits angelegt sein.
brand	MARKEN_ID	Definiert eine Marke für das synchronisierte Dokument.
partnerRole	ROLLEN_ID	Definiert eine Partnerrolle für das Dokument.
validDateFrom	01.01.2019	Definiert ein Datum, ab wann das Dokument sichtbar ist. Format: `DD.MM.YYYY`
validDateUntil	31.12.2019	Definiert ein Datum, bis wann das Dokument sichtbar ist. Format: `DD.MM.YYYY`
lang	de	Definiert, für welche Sprache dieses Dokument verfügbar ist. Der Wert ist ein Sprachkürzel. Alle verfügbaren Sprachen und deren Kürzel finden Sie hier .
countries	de	Definiert, für welche Länder dieses Dokument verfügbar ist. Der Wert ist eine kommaseparierte Liste von Länderkürzeln. Mehrfachangabe des Parameters, um mehrere Länder zu setzen. Alle verfügbaren Länder und deren Kürzel finden Sie hier .

Dokument löschen

URL	/import/catalog/delete
Typ	GET

Pflichtparameter

Parameter	Beispiel	Beschreibung
user	nutzer	Benutzername des für den Import zu nutzenden OXOMI-Anwenders.
token	ABC123	MD5 Hash aus dem API-Token des für den Import zu nutzenden OXOMI-Anwenders und dem aktuellen Tageszeitstempel.
filename	katalog.pdf	PDF-Dateiname des zu löschenden Dokuments (wird für die Suche nach bestehendem Dokument genutzt).
deleteOld	false	Soll das Dokument in OXOMI gelöscht (`true`) oder archiviert (`false`) werden?

Video importieren

URL	/import/video
Typ	POST

Pflichtparameter

Parameter	Beispiel	Beschreibung
user	nutzer	Benutzername des für den Import zu nutzenden OXOMI-Anwenders.
token	ABC123	MD5 Hash aus dem API-Token des für den Import zu nutzenden OXOMI-Anwenders und dem aktuellen Tageszeitstempel.
filename	video.mp4	Dateiname des zu importierenden Videos (wird für die Suche nach bestehendem Video genutzt).
publicName	Marketingvideo	Bestimmt den in OXOMI angezeigten Namen für das Video.
targetLevel	WHOLESALE	Bestimmt die Handelsstufe, für die das Video sichtbar sein soll. `WHOLESALE` für Großhandel,`RETAIL` für Einzelhandel, `END_CUSTOMER` für Endkunden.
forwarding	false	Gibt an, ob das Video an Partner weitergegeben werden soll. Mögliche Werte: `true`/`false`

Optionale Parameter

Parameter	Beispiel	Beschreibung
internalName	1_Preisliste_XYZ	Sollten Sie zwei Bezeichnungen für ein Video verwenden wollen, definieren Sie mit diesem Parameter die nur intern sichtbare Bezeichnung. Der Parameter publicName wird dann zur veröffentlichten Bezeichnung.
description	Dies ist eine Beschreibung.	Hier kann ein Text, der als Beschreibung für das Video benutzt wird, angegeben werden.
code	Marketing	Ergänzend zur ID des Videos können Sie hier einen Code vergeben, über den Sie das Element gezielt ansprechen können.
videoType	product	Definiert den Dokument-Typ. Mögliche Typen und die zu verwendenden Codes finden Sie hier .
category	KATEGORIE_ID	Definiert eine Kategorie für das synchronisierte Video. Diese muss in OXOMI hier vorher bereits angelegt sein.
brand	MARKEN_ID	Definiert eine Marke für das synchronisierte Video.
partnerRole	ROLLEN_ID	Definiert eine Partnerrolle für das Video.
validDateFrom	01.01.2019	Definiert ein Datum, ab wann das Video sichtbar ist. Format: `DD.MM.YYYY`
validDateUntil	31.12.2019	Definiert ein Datum, bis wann das Video sichtbar ist. Format: `DD.MM.YYYY`
lang	de	Definiert, für welche Sprache dieses Video verfügbar ist. Der Wert ist ein Sprachkürzel. Alle verfügbaren Sprachen und deren Kürzel finden Sie hier .
countries	de	Definiert, für welche Länder dieses Video verfügbar ist. Der Wert ist eine kommaseparierte Liste von Länderkürzeln. Mehrfachangabe des Parameters, um mehrere Länder zu setzen. Alle verfügbaren Länder und deren Kürzel finden Sie hier .

Video löschen

URL	/import/video/delete
Typ	GET

Pflichtparameter

Parameter	Beispiel	Beschreibung
user	nutzer	Benutzername des für den Import zu nutzenden OXOMI-Anwenders.
token	ABC123	MD5 Hash aus dem API-Token des für den Import zu nutzenden OXOMI-Anwenders und dem aktuellen Tageszeitstempel.
filename	video.mp4	Dateiname des zu löschenden Videos (wird für die Suche nach bestehendem Video genutzt).
deleteOld	false	Soll das Video in OXOMI gelöscht (`true`) oder archiviert (`false`) werden?

Mediendatei importieren

URL	/import/mediafile
Typ	POST

Pflichtparameter

Parameter	Beispiel	Beschreibung
user	nutzer	Benutzername des für den Import zu nutzenden OXOMI-Anwenders.
token	ABC123	MD5 Hash aus dem API-Token des für den Import zu nutzenden OXOMI-Anwenders und dem aktuellen Tageszeitstempel.
filename	bild.jpg	Dateiname der zu importierenden Mediendatei (wird für die Suche nach bestehender Datei genutzt).

Mediendatei löschen

URL	/import/mediafile/delete
Typ	GET

Pflichtparameter

Parameter	Beispiel	Beschreibung
user	nutzer	Benutzername des für den Import zu nutzenden OXOMI-Anwenders.
token	ABC123	MD5 Hash aus dem API-Token des für den Import zu nutzenden OXOMI-Anwenders und dem aktuellen Tageszeitstempel.
filename	bild.jpg	Dateiname der zu löschenden Mediendatei (wird für die Suche nach bestehender Datei genutzt).

BMEcat XML importieren

URL	/import/bmecat
Typ	POST

Pflichtparameter

Parameter	Beispiel	Beschreibung
user	nutzer	Benutzername des für den Import zu nutzenden OXOMI-Anwenders.
token	ABC123	MD5 Hash aus dem API-Token des für den Import zu nutzenden OXOMI-Anwenders und dem aktuellen Tageszeitstempel.
filename	bmecat.xml	Dateiname der BMEcat-Datei
readVideos	false	Sollen Videos auch eingelesen werden? Mögliche Werte: `true`/`false`
levelVideos	WHOLESALE	Bestimmt die Handelsstufe, die die eingelesenen Videos erhalten sollen. `WHOLESALE` für Großhandel,`RETAIL` für Einzelhandel, `END_CUSTOMER` für Endkunden.
readExplosions	false	Sollen Explosionszeichnungen als Exposés eingelesen werden? Mögliche Werte: `true`/`false`
levelExplosions	WHOLESALE	Bestimmt die Handelsstufe, die die eingelesenen Explosionszeichnungen erhalten sollen. `WHOLESALE` für Großhandel,`RETAIL` für Einzelhandel, `END_CUSTOMER` für Endkunden.

Optionale Parameter

Parameter	Beispiel	Beschreibung
validDateFrom	01.01.2019	Definiert ein Datum, ab wann das Video sichtbar ist. Format: `DD.MM.YYYY`
validDateUntil	31.12.2019	Definiert ein Datum, bis wann das Video sichtbar ist. Format: `DD.MM.YYYY`
lang	de	Definiert, für welche Sprache die importierten Daten verfügbar sind. Der Wert ist ein Sprachkürzel. Alle verfügbaren Sprachen und deren Kürzel finden Sie hier .
countries	de	Definiert, für welche Länder die importierten Daten verfügbar sind. Der Wert ist eine kommaseparierte Liste von Länderkürzeln. Mehrfachangabe des Parameters, um mehrere Länder zu setzen. Alle verfügbaren Länder und deren Kürzel finden Sie hier .
prefix	data/media/	Falls vorhanden, wird dieser Präfix an den Anfang jedes Dateipfades gehängt, bevor die entsprechende Datei im Medien-Pool gesucht wird. Eventuell bestehende Ordnerstrukturen können so berücksichtigt werden.
deleteFile	true	Soll die hochgeladene XML-Datei nach Vollendung des Jobs automatisch wieder gelöscht werden? Mögliche Werte: `true`/`false`

Zurück zur Übersicht