Die Dataclip-Funktion von OXOMI befindet sich derzeit in der Beta-Testphase, dementsprechend sind alle Angaben unter Vorbehalt von Änderungen.
Dataclips sind ein OXOMI-Service, der Artikeldaten eines OXOMI-Portals mit von Ihnen übermittelten Angaben eines Angebots kombiniert. So wird ein Online-Angebot erstellt, bei dem im Angebot die Artikeldaten des Herstellers (Bilder, Stammdaten, Langtext, Downloads, Videos, Dokumente), soweit vorhanden, aufgerufen werden können. Nach dem Sie die Daten an den Service übermittelt haben, liefert dieser eine URL aus, die Sie Ihrem Kunden als “aufbereitetes” Angebot schicken können. Diese URL ist 180 Tage gültig.
Die Einrichtung und somit auch die Programmierung der Übergabe der Daten des Angebots an OXOMI erfolgt auf Seiten Ihres ERP.
Sicherheitshinweis: Wenn Sie für die Dataclips ein Login-geschütztes Einzelhandelsportal nutzen möchten, sollten die so erstellten Angebote auch nur an Kunden gesendet werden, die Zugriff auf die Informationen in Ihrem Einzelhandelsportal erhalten dürfen (in der Regel also jeder, der über einen Shop-Login verfügt). Das hat den Grund, dass die erstellten Links einem zwar nur das vom Service erstellte Angebot zugänglich machen, es aber theoretisch möglich ist mit einer gewissen Fachkenntnis die Authentifizierung zum Portal aus dem JavaScript-Aufruf im Hintergrund zu ziehen und so alle Inhalte des Portals einsehen zu können.
Dataclips werden über einen “POST”-Serviceaufruf an "/service/json/dataclip/create" bzw. "/service/xml/dataclip/create" erstellt. Die Parameter sollten im Body des POST-Aufrufs gesendet werden, da die maximale Länge einer URL bei der benötigten Anzahl an Parametern schnell erreicht ist.
| Name | Beschreibung |
|---|---|
| p | Code des Portals in dem der Paperclip erstellt werden soll. |
| user | Der Portalnutzer, welcher den Dataclip erstellt |
| accessToken | Zugangscode für den Portalbenutzer, siehe http://oxomi.com/help/de/integration/authentifizierung |
| dataclipRoles | Portalrollen des Dataclip-Users, welcher dann den Dataclip nutzt |
| Name | Beschreibung | Default |
|---|---|---|
| quote | Angebotsnummer | |
| commission | Kommission | |
| date | Datum für das Angebot im DD.MM.YYYY Format (bsp.: 23.04.2018) |
Aktuelles Datum |
| text | Ein Freitext am Anfang des Dataclips | |
| headerImage | Eine Url für ein Bild im Header | |
| price | Gesamtpreis für das Angebot | |
| currency | Währung für Preise im Angebot | EUR |
| contactName | Name des Ansprechpartners | |
| contactMail | Mail des Ansprechpartners | |
| contactPhone | Telefonnummer des Ansprechpartners |
Die Namen der Positions-Parameter müssen immer auf eine fortlaufende Nummer enden. Für die erste Position ist diese Zahl 1, für die zweite 2 usw. Dies wird auch im nächsten Kapitel beispielhaft aufgezeigt. In der untenstehenden Tabelle sind diese platzhaltermäßig durch ein X gekennzeichnet.
| Name | Beschreibung |
|---|---|
| typeX | Muss für Texte text sein |
| textX | Der Text der Textposition |
| positionX | Die Positionsnummer dieser Position. Wenn keine angegeben wird, wird die fortlaufende Zahl am Ende der Parameternamen verwendet. |
| parentX | Die übergeordnete Position. Wenn keine vorhanden, einfach weglassen. Wenn vorhanden den Wert aus "position" der übergeordneten Position nutzen. |
| Name | Beschreibung |
|---|---|
| typeX | Muss für Artikel item sein |
| preTextX | Kopftext |
| itemX | Artikelnummer |
| supplierX | Lieferantennummer |
| textX | Text für Artikel |
| amountX | Menge |
| unitX | Mengeneinheit |
| postTextX | Fußtext |
| alternativeToX | Alternative zu |
| unitCostX | Einzelpreis |
| positionCostX | Positionspreis |
| positionX | Die Positionsnummer dieser Position. Wenn keine angegeben wird, wird die fortlaufende Zahl am Ende der Parameternamen verwendet. |
| parentX | Die übergeordnete Position. Wenn keine vorhanden, einfach weglassen. Wenn vorhanden den Wert aus "position" der übergeordneten Position nutzen. |
| Parameter | Parameterwert |
|---|---|
| quote | Angebot123 |
| commission | Kommission |
| date | 01.05.2018 |
| text | Hallo Herr/Frau XYZ, hier unser Angebot für Ihr Projekt. |
| headerImage | http://www.scireum.de/scireum/files/scireum_Logo.jpg |
| price | 10.499 |
| currency | EUR |
| contactName | Max Mustermann |
| contactMail | mm@firma.test |
| contactPhone | 0711/12345 |
| type1 | text |
| text1 | Ein Text für Kategorie 1 |
| position1 | 100 |
| type2 | item |
| preText2 | Kopftext der Artikelposition |
| item2 | ARTIKELNR |
| supplier2 | LIEFERANTENNR |
| text2 | Das ist ein Kurztext für den Artikel |
| amount2 | 3 |
| unit2 | Meter |
| postText2 | Der Fußtext der Artikelposition |
| unitCost2 | 100 |
| positionCost2 | 300 |
| parent2 | 100 |
| position2 | 150 |
JSON bzw. XML mit den folgenden Feldern:
| success | true |
| error | false |
| url | Url zu Dataclip |
JSON bzw. XML mit den folgenden Feldern:
| success | false |
| error | true |
| message | Fehlermeldung, welche Problem beschreibt |
| type | Typ der Exception |
| code | Fehlercode |
| flow | Informationen zu Server und Thread |