OXID Connect

Das Addon “OXID Connect” kann jederzeit mit wenigen Vorbereitungen einem bestehenden GREYHOUND-Vertrag hinzugebucht werden. Der GREYHOUND Server und die Clients installieren das Addon dann vollautomatisch.

Vorbereitung im OXID eShop

1. Das Addon “OXID Connect” benötigt ein zugehöriges Modul, um eine API bereit zu stellen, über die alle vom Addon benötigten Daten möglichst effizient aus dem OXID eShop abgerufen werden können. Für OXID eShop 6 wird das Modul über Composer installiert, für die Versionen 4 und 5 kann dieses Modul, wie auch das GREYHOUND Basismodul, im OXID eXchange heruntergeladen werden.

OXID eShop 6

Das GREYHOUND OXID Connect Modul für OXID eShop 6 wird über das Composer Kommando auf der Kommandozeile hinzugefügt:
composer require greyhound-software/greyhound-oxid6-connect:^2.0.0

Danach wird das hinzugefügte Modul installiert:
composer install --no-dev

Das Modul ist nun im Administrationsbereich des Shops unter “Erweiterungen” > “Module” in der Liste als “GREYHOUND OXID Connect Modul” zu finden. Das Modul muss nun aktiviert werden (im Tab “Stamm”). Im Tab “Einstell.” kann das Modul dann bei Bedarf konfiguriert werden. Hier finden sich auch der API Key und die API URL, die im weiteren Verlauf für die Einrichtung des GREYHOUND OXID Connect Addons in GREYHOUND benötigt werden.
Der API Key wird automatisch zufällig erzeugt, wenn das Modul aktiviert wird. Er kann nach Belieben geändert werden – der aktuelle API Key muss dann in den Addon Einstellungen in GREYHOUND hinterlegt werden. Die API URL wird automatisch ermittelt und gibt immer die URL an, unter der die Schnittstelle des Moduls erreichbar ist. Sie wird ebenfalls für die Einstellungen des GREYHOUND Addons benötigt.

Die Option “Unsichere Verbindung zulassen” wird nur benötigt, wenn das Shop-Frontend nicht über eine SSL-Verbindung erreichbar ist. Das Modul verweigert unsichere Verbindungen, da über die Schnittstelle Kunden- und Auftragsdaten übertragen werden.
Die Option “Daten der Subshops über die API des Hauptshops zur Verfügung stellen” kann aktiviert werden um in einem Shop mit mehreren Subshops die Daten der Subshops ebenfalls über die Schnittstelle des Haupt-Shops abrufbar zu machen. Auf diese Weise muss dann in GREYHOUND in den Addon Einstellungen nur eine Verbindung zum Hauptshop eingerichtet werden und nicht eine Verbindung pro Subshop.

OXID eShop 4 und 5

Für OXID eShop Version 4 und 5 wird das GREYHOUND OXID Connect Modul über OXID eXchange bezogen und im Shop installiert. Dieses Modul erfordert zusätzlich das GREYHOUND OXID Basismodul.

Das Basismodul wird im eXchange einmal für die Community Edition (CE) und einmal für die Professional und Enterprise Edition (PE/EE) angeboten. Beide Versionen sind identisch, OXID ermöglicht lediglich keine Einstellung für alle drei Systeme zugleich.

Das OXID Connect Modul muss nun im Administrationsbereich des Shops konfiguriert werden. Hier muss ein API Key erzeugt (oder festgelegt) werden. Die API URL und der API Key werden später in GREYHOUND für die Konfiguration des Addons benötigt und können aus den entsprechenden Textfeldern auf der Konfigurationsseite kopiert werden.

Das GREYHOUND Basismodul muss nicht zwingend konfiguriert werden, es stellt nur einige Funktionen im Shop bereit, auf die das OXID Connect Modul zurückgreift.

3. Das OXID Connect Addon kann über den GREYHOUND Kundenservice oder das Control Center zum Vertrag hinzugebucht werden und wird dann automatisch installiert, sobald der GREYHOUND Server neu startet oder ein Administrator die Funktion “Addons aktualisieren” verwendet. Die GREYHOUND Clients beziehen das Addon vom Server wenn sie sich das nächste Mal mit ihm verbinden.

  • Nach dem Login unter Verträge den Vertrag auswählen und bearbeiten

  • Unter den Vertragsinhalten auf Produkte ändern klicken

  • Das gewünschte Addon hinzubuchen

  • Änderungen mit Weiter bestätigen

  • Änderungen überprüfen und übernehmen

Wichtig: Kunden im Eigenbetrieb müssen die Verwendung des gebuchten Addons zusätzlich im GREYHOUND Admin aktivieren (-> Anleitung siehe hier).

4. Nach der Installation des Addons sollte der Administrator im Client unter “Einstellungen” -> “Erweiterungen” die Benutzergruppen festlegen, die auf die “OXID Connect”-Erweiterung zugreifen dürfen.5. Im Client kann unter “Erweiterungen” -> “OXID Connect – Einstellungen“ das Addon konfiguriert werden. Hier müssen die API URL und der API Key des OXID eShops eingetragen werden. Diese können in der Konfigurationsseite des OXID Connect Moduls im OXID eShop eingesehen und kopiert werden (siehe Schritt 2).

Variablen für Textbausteine

Beim Antworten oder Verfassen einer Nachricht über die Buttons in der Seitenleiste des Addons stellt das Addon einige Variablen bereit, die im Text der Nachricht oder in eingefügten Textbausteinen ersetzt werden. Der Inhalt der Variablen hängt von den Auftrags- und Kundendaten ab, die das Addon ermittelt hat. So können z.B. Variablen wie die Lieferanschrift leer sein, wenn in den Auftragsdaten keine separate Lieferanschrift übermittelt wurde. Wie üblich kann die Vorschaufunktion beim Verfassen der Nachricht genutzt werden, um zu überprüfen, durch welche Daten die Variablen ersetzt werden.

Es folgt eine Auflistung der Variablen und ihres Inhalts:

Variable
Beschreibung
[$Order.OrderNumber]Bestellnummer
[$Order.InvoiceNumber]Rechnungsnummer
[$Order.CustomerNumber]Kundennummer
[$Order.Date]Bestelldatum (Tag.Monat.Jahr)
[$Order.DateInfo.D]Bestelldatum (Tag, z.B. “01”)
[$Order.DateInfo.M]Bestelldatum (Monat, z.B. “02”)
[$Order.DateInfo.Y]Bestelldatum (Jahr, z.B. “2013”)
[$Order.DateInfo.Day.DE]Bestelldatum (Tag auf deutsch, z.B. “Montag”)
[$Order.DateInfo.Day.EN]Bestelldatum (Tag auf englisch, z.B. “Monday”)
[$Order.DateInfo.Day.ES]Bestelldatum (Tag auf spanisch, z.B. “Lunes”)
[$Order.DateInfo.Day.FR]Bestelldatum (Tag auf französisch, z.B. “Lundi”)
[$Order.DateInfo.Month.DE]Bestelldatum (Monat auf deutsch, z.B. “Januar”)
[$Order.DateInfo.Month.EN]Bestelldatum (Monat auf englisch, z.B. “January”)
[$Order.DateInfo.Month.ES]Bestelldatum (Monat auf spanisch, z.B. “Enero”)
[$Order.DateInfo.Month.FR]Bestelldatum (Monat auf französisch, z.B. “Janvier”)
[$Order.DateInfo.Timestamp]Bestelldatum (Unix-Zeitstempel, Sekunden seit 01.01.1970)
[$Order.Platform]Gesamtbetrag des Auftrags inkl. Währung
[$Order.TotalAmountInfo.Value]Gesamtbetrag des Auftrags (Zahl mit Dezimalpunkt)
[$Order.TotalAmountInfo.Currency]Währung des Gesamtbetrags (drei Buchstaben)


[$BillingAddress.Company]Rechnungsanschrift: Firma
[$BillingAddress.Salutation]Rechnungsanschrift: Anrede
[$BillingAddress.Sex.Number]Rechnungsanschrift: Geschlecht (“0” = unbekannt, “1” = männlich, “2” = weiblich)
[$BillingAddress.Sex.Name]Rechnungsanschrift: Geschlecht (“Unbekannt”, “Männlich”, “Weiblich”)
[$BillingAddress.Name]Rechnungsanschrift: Vorname und Nachname
[$BillingAddress.Firstname]Rechnungsanschrift: Vorname
[$BillingAddress.Lastname]Rechnungsanschrift: Nachname
[$BillingAddress.Letter.Identifier]Rechnungsanschrift: Straße, Postleitzahl, Stadt, Land in einer Zeile (komma-getrennt)
[$BillingAddress.Letter.Street]Rechnungsanschrift: Straße und Hausnummer
[$BillingAddress.Letter.AdditionalInfo]Rechnungsanschrift: Zusatzinfo (z.B. Appartment, Etage)
[$BillingAddress.Letter.ZipCode]Rechnungsanschrift: Postleitzahl
[$BillingAddress.Letter.City]Rechnungsanschrift: Stadt
[$BillingAddress.Letter.Province]Rechnungsanschrift: Bundesstaat/Provinz
[$BillingAddress.Letter.Country]Rechnungsanschrift: Land
[$BillingAddress.Letter.CountryInfo.ISO2]Rechnungsanschrift: ISO3166 Länderkürzel (zwei Buchstaben)
[$BillingAddress.Letter.CountryInfo.ISO3]Rechnungsanschrift: ISO3166 Länderkürzel (drei Buchstaben)
[$BillingAddress.Letter.CountryInfo.DE]Rechnungsanschrift: Land (deutsche Schreibweise)
[$BillingAddress.Letter.CountryInfo.DE_UC]Rechnungsanschrift: Land (deutsche Schreibweise, Blockbuchstaben)
[$BillingAddress.Letter.CountryInfo.EN]Rechnungsanschrift: Land (englische Schreibweise)
[$BillingAddress.Letter.CountryInfo.EN_UC]Rechnungsanschrift: Land (englische Schreibweise, Blockbuchstaben)
[$BillingAddress.Letter.CountryInfo.ES]Rechnungsanschrift: Land (spanische Schreibweise)
[$BillingAddress.Letter.CountryInfo.ES_UC]Rechnungsanschrift: Land (spanische Schreibweise, Blockbuchstaben)
[$BillingAddress.Letter.CountryInfo.FR]Rechnungsanschrift: Land (französische Schreibweise)
[$BillingAddress.Letter.CountryInfo.FR_UC]Rechnungsanschrift: Land (französische Schreibweise, Blockbuchstaben)
[$BillingAddress.Email]Rechnungsanschrift: E-Mail Adresse
[$BillingAddress.Phone]Rechnungsanschrift: Telefonnummer
[$BillingAddress.Fax]Rechnungsanschrift: Faxnummer


[$ShippingAddress.Company]Lieferanschrift: Firma
[$ShippingAddress.Salutation]Lieferanschrift: Anrede
[$ShippingAddress.Sex.Number]Lieferanschrift: Geschlecht (“0” = unbekannt, “1” = männlich, “2” = weiblich)
[$ShippingAddress.Sex.Name]Lieferanschrift: Geschlecht (“Unbekannt”, “Männlich”, “Weiblich”)
[$ShippingAddress.Name]Lieferanschrift: Vorname und Nachname
[$ShippingAddress.Firstname]Lieferanschrift: Vorname
[$ShippingAddress.Lastname]Lieferanschrift: Nachname
[$ShippingAddress.Letter.Identifier]Lieferanschrift: Straße, Postleitzahl, Stadt, Land in einer Zeile (komma-getrennt)
[$ShippingAddress.Letter.Street]Lieferanschrift: Straße und Hausnummer
[$ShippingAddress.Letter.AdditionalInfo]Lieferanschrift: Zusatzinfo (z.B. Appartment, Etage)
[$ShippingAddress.Letter.ZipCode]Lieferanschrift: Postleitzahl
[$ShippingAddress.Letter.City]Lieferanschrift: Stadt
[$ShippingAddress.Letter.Province]Lieferanschrift: Bundesstaat/Provinz
[$ShippingAddress.Letter.Country]Lieferanschrift: Land
[$ShippingAddress.Letter.CountryInfo.ISO2]Lieferanschrift: ISO3166 Länderkürzel (zwei Buchstaben)
[$ShippingAddress.Letter.CountryInfo.ISO3]Lieferanschrift: ISO3166 Länderkürzel (drei Buchstaben)
[$ShippingAddress.Letter.CountryInfo.DE]Lieferanschrift: Land (deutsche Schreibweise)
[$ShippingAddress.Letter.CountryInfo.DE_UC]Lieferanschrift: Land (deutsche Schreibweise, Blockbuchstaben)
[$ShippingAddress.Letter.CountryInfo.EN]Lieferanschrift: Land (englische Schreibweise)
[$ShippingAddress.Letter.CountryInfo.EN_UC]Lieferanschrift: Land (englische Schreibweise, Blockbuchstaben)
[$ShippingAddress.Letter.CountryInfo.ES]Lieferanschrift: Land (spanische Schreibweise)
[$ShippingAddress.Letter.CountryInfo.ES_UC]Lieferanschrift: Land (spanische Schreibweise, Blockbuchstaben)
[$ShippingAddress.Letter.CountryInfo.FR]Lieferanschrift: Land (französische Schreibweise)
[$ShippingAddress.Letter.CountryInfo.FR_UC]Lieferanschrift: Land (französische Schreibweise, Blockbuchstaben)
[$ShippingAddress.Phone]Lieferanschrift: Telefonnummer
[$ShippingAddress.Fax]Lieferanschrift: Faxnummer


[$Payment.Method]Zahlungsart
[$Payment.Costs]Kosten der Zahlungsart inkl. Währung
[$Payment.CostsInfo.Value]Kosten der Zahlungsart (Zahl mit Dezimalpunkt)
[$Payment.CostsInfo.Currency]Währung der Kosten der Zahlungsart (drei Buchstaben)
[$Payment.Date]Zahlungsdatum (Tag.Monat.Jahr)
[$Payment.DateInfo.D]Zahlungsdatum (Tag, z.B. “01”)
[$Payment.DateInfo.M]Zahlungsdatum (Monat, z.B. “02”)
[$Payment.DateInfo.Y]Zahlungsdatum (Jahr, z.B. “2013”)
[$Payment.DateInfo.Day.DE]Zahlungsdatum (Tag auf deutsch, z.B. “Montag”)
[$Payment.DateInfo.Day.EN]Zahlungsdatum (Tag auf englisch, z.B. “Monday”)
[$Payment.DateInfo.Day.ES]Zahlungsdatum (Tag auf spanisch, z.B. “Lunes”)
[$Payment.DateInfo.Day.FR]Zahlungsdatum (Tag auf französisch, z.B. “Lundi”)
[$Payment.DateInfo.Month.DE]Zahlungsdatum (Monat auf deutsch, z.B. “Januar”)
[$Payment.DateInfo.Month.EN]Zahlungsdatum (Monat auf englisch, z.B. “January”)
[$Payment.DateInfo.Month.ES]Zahlungsdatum (Monat auf spanisch, z.B. “Enero”)
[$Payment.DateInfo.Month.FR]Zahlungsdatum (Monat auf französisch, z.B. “Janvier”)
[$Payment.DateInfo.Timestamp]Zahlungsdatum (Unix-Zeitstempel, Sekunden seit 01.01.1970)
[$Payment.TransactionID]Transaktions-ID des Zahlungsanbieters


[$Shipping.Provider]Versanddienstleister
[$Shipping.Costs]Versandkosten inkl. Währung
[$Shipping.CostsInfo.Value]Versandkosten (Zahl mit Dezimalpunkt)
[$Shipping.CostsInfo.Currency]Währung der Versandkosten (drei Buchstaben)
[$Shipping.Date]Lieferdatum (Tag.Monat.Jahr)
[$Shipping.DateInfo.D]Lieferdatum (Tag, z.B. “01”)
[$Shipping.DateInfo.M]Lieferdatum (Monat, z.B. “02”)
[$Shipping.DateInfo.Y]Lieferdatum (Jahr, z.B. “2013”)
[$Shipping.DateInfo.Day.DE]Lieferdatum (Tag auf deutsch, z.B. “Montag”)
[$Shipping.DateInfo.Day.EN]Lieferdatum (Tag auf englisch, z.B. “Monday”)
[$Shipping.DateInfo.Day.ES]Lieferdatum (Tag auf spanisch, z.B. “Lunes”)
[$Shipping.DateInfo.Day.FR]Lieferdatum (Tag auf französisch, z.B. “Lundi”)
[$Shipping.DateInfo.Month.DE]Lieferdatum (Monat auf deutsch, z.B. “Januar”)
[$Shipping.DateInfo.Month.EN]Lieferdatum (Monat auf englisch, z.B. “January”)
[$Shipping.DateInfo.Month.ES]Lieferdatum (Monat auf spanisch, z.B. “Enero”)
[$Shipping.DateInfo.Month.FR]Lieferdatum (Monat auf französisch, z.B. “Janvier”)
[$Shipping.DateInfo.Timestamp]Lieferdatum (Unix-Zeitstempel, Sekunden seit 01.01.1970)
[$Shipping.Tracking.Code]Sendungsnummer / Tracking-Code


[$Addon.Name]Name des Addons
[$Addon.Version]Version des Addons (z.B. “1.2.3 build 456”)
[$Addon.VersionInfo.Number]Versionsnummer des Addons (z.B. “1.2.3”)
[$Addon.VersionInfo.Build]Build-Nummer des Addons (z.B. “456”)