|
|
# Quick Start Guide CrefoPay Plugin "Payments" für Oxid eShop
|
|
|
|
|
|
## 1. Einleitung
|
|
|
|
|
|
Dieser Quick Start Guide soll die Installation und Konfiguration des CrefoPay Payment Plugin für den Oxid eShop 6 vereinfachen. Die Schritt für Anleitung beinhaltet alle notwenidgen Schritte zur Inbetriebnahme. Weiterfürende Informationen sind in dem umfangreicheren [Benutzerhandbuch](doc/admin/manual.md) enthalten.
|
|
|
|
|
|
### 1.1 Bevor es los geht
|
|
|
|
|
|
Bevor es mit der Installation und Konfiguration des CrefoPay Payment Plugin los gehen kann, sollten die folgenden Informationen bereit gehalten werden:
|
|
|
|
|
|
* Shell-Zugang zu Ihrer Oxid Installation
|
|
|
* CrefoPay Payment Plugin für Oxid eShop 6[^2]
|
|
|
* Unterstützte Oxid-Versionen: 6.0 - 6.4
|
|
|
* CrefoPay Zugangsdaten[^3]
|
|
|
* Merchant ID
|
|
|
* Store ID(s)
|
|
|
* Public Key
|
|
|
* Private Key
|
|
|
|
|
|
|
|
|
### 1.2 Haftungsausschluss
|
|
|
|
|
|
Die CrefoPayment GmbH & Co. KG als Herausgeber der Software übernimmt keinerlei Haftung für etwaige Schäden, die durch die Verwendung des CrefoPay Payment Plugin entstehen. Um vor der Inbetriebnahme im Produktivbetrieb ausfühliche Funktions-Tests durchfüren zu können, kann beim CrefoPay Service Team unter [service@crefopay.de](mailto:service@crefopay.de) ein Zugang zur CrefoPay [Sandbox](https://sandbox.crefopay.de) angefragt werden.
|
|
|
|
|
|
### 2 Backup
|
|
|
|
|
|
Das CrefoPay Payment Plugin ist ausführlich getestet und von der Qaulitätssicherung der CrefoPayment GmbH & Co. KG geprüft und freigegeben worden. Dennoch kann es bei jeder Software unter ungüstigen Umständen zu unerwarteten Fehlern bei der Installation bzw. der Inbetriebnahme kommen. Aus diesem Grund wird *dringend* dazu geraten eine Systemsicherung (Backup) zu erstellen, bevor die Software installiert und in Betrieb genommen wird.
|
|
|
|
|
|
## 3. Installation
|
|
|
|
|
|
Das CrefoPay Payment Plugin wird als composer-Paket via packagist.org bereitgestellt und wird über composer installiert:
|
|
|
1. Wechseln Sie in das Hauptverzeichnis der Shop-Installation (das Verzeichnis in dem sich die 'source'- und 'vendor'-Ordner befinden)
|
|
|
2. Führen Sie `composer require crefopay/cppayments-oxid6-module` aus, um das Modul zu installieren
|
|
|
3. Das Modul ist nun im Oxid-Backend unter Erweiterungen > Module sichtbar und kann dort aktiviert werden (siehe [4])
|
|
|
|
|
|
Falls der composer-Befehl nicht verfügbar ist, müssen Sie ggf. Ihren Hoster um Support bitten.
|
|
|
Falls composer require erfolgreich durchgeführt wurde, das Modul im Oxid-Backend aber nicht sichtbar wird: Führen sie folgendes aus:
|
|
|
`vendor/bin/oe-console oe:module:install-configuration source/modules/crefopay/cppayments` um das Modul in die yaml eintragen zu lassen
|
|
|
|
|
|
## 4. Aktivierung
|
|
|
|
|
|
### 4.1 Eintragen der Zugangsdaten
|
|
|
|
|
|
<lead>Für die Aktivierung des CrefoPay Payment Plugin werden die CrefoPay Zugangsdaten[^3] benötigt.</lead>
|
|
|
Die Aktivierung der CrefoPay Bezahlarten erfolgt über den Menüpunkt *Erweiterungen > Module* im Oxid Backend.
|
|
|
|
|
|
1. Zunäst muss das Modul *CrefoPay Bezahlarten* angeklickt werden, um den Stamm-Tab zu öffnen.
|
|
|
2. Als nästes muss auf den *Einstell.* Tab gewechselt und der Bereich Zugangsdaten geöffnet werden.
|
|
|
3. Dort sind nun die bereitgestellten CrefoPay Zugangsdaten einzutragen und anschließend mit *Speichern* zu bestätigen. **Hinweis:** Die Fragezeichen-Symbole liefern weitere Informationen zu den zugehörigen Eingabefeldern.
|
|
|
4. Zuletzt kann das Plugin durch einen Klick auf *Aktivieren* aktiviert werden. **Hinweis:** Sollten bei der Aktivierung Fehler auftreten werden diese angezeigt. Der angezeigten Fehler sollte unbedingt DOkumentiert werden, damit dass das [CrefoPay Service Team](mailto:service@crefopay.de) bei der Lösung etwaiger Fehler bestmöglich unterstützen kann.
|
|
|
|
|
|
### 4.2 Aktivierung der CrefoPay Bezahlarten
|
|
|
|
|
|
1. Zunächst muss die zu aktivierende Zahlungsart in der Liste angeklickt werden. **Hinweis:** Sind sehr viele Zahlungsarten im Shop verfügbar, kann die Suchfunktion genutzt werden, in dem der Begriff *CrefoPay* in die Suchleiste eingtragen wird.
|
|
|
2. Nach dem anklicken einer Bezahlart kann diese individuell konfiguriert werden[^4].
|
|
|
3. Zur Aktivierung der Bezahlart muss nun die Checkbox *Aktiv* gesetzt werden.
|
|
|
4. Im Feld *Name* ist der im Shop Frontend anzuzeigende Name der Bezahlart zu definieren.
|
|
|
5. Zuletzt werden die Einstellungen mit einem Klick auf *Speichern* übernommen.
|
|
|
*Die Schritte 1 bis 5 müssen für alle zu aktivierenden CrefoPay Bezahlarten wiederholt werden.*
|
|
|
6. Ordnen Sie die Crefopay-Zahlarten Ihren Versandarten zu, siehe dazu: https://docs.oxid-esales.com/eshop/de/6.2/einrichtung/versandarten/registerkarte-zahlungsarten.html
|
|
|
|
|
|
[^4]: Genauere Informationen zu den möglichen Konfigutationsoptionen können der Oxid eShop Dokumentation entnommen werden. Der Quick Start Guide beschräkt sich ausschließlich auf die für die AKtivierung von CrefoPay wichtigen Informationen.
|
|
|
|
|
|
## 5. Konfiguration
|
|
|
|
|
|
<lead>Die Konfiguration des Moduls erfolgt, ebenso wie bereits die Aktivierung, über den *Einstell.* Tab. Im Folgenden sind die möglichen Optionen tabellarisch zusammengefasst.</lead>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>#</th>
|
|
|
<th>Option</th>
|
|
|
<th>Kategorie</th>
|
|
|
<th>Werte</th>
|
|
|
<th>Bemerkung</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>1.1</td>
|
|
|
<td>Betriebsmodus</td>
|
|
|
<td>Umgebung</td>
|
|
|
<td>Sandbox<br>Livebetrieb</td>
|
|
|
<td>Im Rahmen der CrefoPay Integration werden zunächst Sandbox Daten verwendet, um die Anbindung an CrefoPay in einer Staging-Umgebung zu testen.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>1.2</td>
|
|
|
<td>Standard Sprache</td>
|
|
|
<td>Umgebung</td>
|
|
|
<td>Deutsch<br>Englisch<br>Spanisch<br>Französisch<br>Italienisch<br>Niederländisch</td>
|
|
|
<td>Das CrefoPay Modul verwendet, soweit möglich, die vom Browser des Endkunden vorgegebene Spracheinstellung. Wird eine nicht unterstützte Sprache erkannt, wird die hier festgelegte Standard Sprache verwendet.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>1.3</td>
|
|
|
<td>Nicht CrefoPay Bezahlarten</td>
|
|
|
<td>Umgebung</td>
|
|
|
<td>Ausblenden<br>Erlauben</td>
|
|
|
<td>Das CrefoPay Modul ist in der Lage, konkurrierende Bezahlarten auszublenden. Steht diese Option auf <i>Ausblenden</i> werden ausschließlich CrefoPay Bezahlarten im Checkout erlaubt.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>1.4.1</td>
|
|
|
<td>Log Level</td>
|
|
|
<td>Umgebung</td>
|
|
|
<td>Debug<br>Warn<br>Error</td>
|
|
|
<td>Das Modul verfügt über verschiedene Protokollierungslevel. <i>Debug</i> protokolliert alle relevanten Aktionen des Moduls. <i>Warn</i> protokolliert schwere und leichte Fehler des Moduls. <i>Error</i> protokolliert nur die schweren Fehler, die kritische Auswirkungen auf die Prozessabläfe der CrefoPay Anbindung haben.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>1.4.2</td>
|
|
|
<td>Log Datei</td>
|
|
|
<td>Umgebung</td>
|
|
|
<td><i>Textfeld</i></td>
|
|
|
<td>Neben der Standard Log Datei <code>crefopay.log</code> kann hier ein individueller Dateiname für das Logfile angegeben werden.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>2.1</td>
|
|
|
<td>Auto Capture</td>
|
|
|
<td>Bestellungen</td>
|
|
|
<td><i>Checkbox</i></td>
|
|
|
<td>Der Auto Capture sorgt dafür, dass CrefoPay Bestellungen direkt bei Authorisierung durch den Endkunden bereits gebucht, also in Rechnung gestellt werden. Diese Funktion sollte nur für den Verkauf digitaler Güter oder in Absprache mit dem CrefoPay Service Team aktiviert werden.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>2.2</td>
|
|
|
<td>Business Transaktionen</td>
|
|
|
<td>Bestellungen</td>
|
|
|
<td>Deaktivieren<br>Aktivieren</td>
|
|
|
<td>Ist diese Funktion deaktiviert, werden alle Bestellungen automatisch als Privatkundentransaktionen behandelt. Bei aktivierter Option, werden Transaktionen, bei deinen ein Firmenname angegeben wurde als Businesstransaktion behandelt. Für die Bezahlarten Rechnung und Lastschrift bedeutet das auch, dass die entsprechende Schnittstelle zur Bonitätsabfrage angesprochen wird.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>2.3</td>
|
|
|
<td>Zahlungsziel Vorkasse</td>
|
|
|
<td>Bestellungen</td>
|
|
|
<td><i>Textfeld (INT)</i></td>
|
|
|
<td>Das Modul erweitert unter anderem die E-Mail zur Bestellbestätigung und ergänzt diese im Falle einer Bestellung mit der Bezahlart Vorkasse um die für den Endkunden wichtigen (Bankkonto-) Informationen. Mit dieser Option kann das Zahlungsziel (in Tagen) angegeben werden, zu dem eine Überweisung des Käufers spätestens erwartet wird.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>2.4</td>
|
|
|
<td>Zahlungsziel Rechnung</td>
|
|
|
<td>Bestellungen</td>
|
|
|
<td><i>Textfeld (INT)</i></td>
|
|
|
<td>Ähnlich wir das Zahlungsziel für Vorkasse kann hier festgelegt werden, ab welchem Zeitraum (in Tagen) die Zahlung der Rechnung durch den Käufer fällig wird.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>2.5.1</td>
|
|
|
<td>Gültigkeit Warenkorb</td>
|
|
|
<td>Bestellungen</td>
|
|
|
<td><i>Textfeld (INT)</i></td>
|
|
|
<td>CrefoPay Transaktionen haben eine Gültigkeit zwischen Erstellung und erfolgreichem Abschluss. Mit dieser Option kann dieser Zeitraum definiert werden. Hier <b>muss</b> eine Zahl angegeben werden da es sonst zu Kommnunikationsfehlern mit der CrefoPay API kommt.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>2.5.2</td>
|
|
|
<td>Einheit der Gültigkeitsdauer</td>
|
|
|
<td>Bestellungen</td>
|
|
|
<td>Stunden<br>Minuten<br>Tage</td>
|
|
|
<td>Hier wird die zu 2.6.1 gehörende Einheit festgelegt.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>3.1</td>
|
|
|
<td>CVV Hilfe</td>
|
|
|
<td>Payment Logos</td>
|
|
|
<td>Einblenden<br>Ausblenden</td>
|
|
|
<td>Mit dieser Option wird bei Auswahl der Bezahlart Kreditkarte im Checkout ein Bild eingeblendet, in dem markiert ist, wo der Endkunde auf seiner Kreditkarte die CVV findet.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>3.2</td>
|
|
|
<td>MasterCard Logo</td>
|
|
|
<td>Payment Logos</td>
|
|
|
<td>Einblenden<br>Ausblenden</td>
|
|
|
<td>Mit dieser Option wird bei Auswahl der Bezahlart Kreditkarte im Checkout das MasterCard Logo angezeigt.</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>3.3</td>
|
|
|
<td>VISA Logo</td>
|
|
|
<td>Payment Logos</td>
|
|
|
<td>Einblenden<br>Ausblenden</td>
|
|
|
<td>Mit dieser Option wird bei Auswahl der Bezahlart Kreditkarte im Checkout das VISA Logo angezeigt.</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table> |
|
|
\ No newline at end of file |