Gold API - Modul für PrestaShop
Produktpreise einfach und automatisiert mit goldapi.io verbinden.
- Einführung
- Installation
- Einrichtung
- GoldAPI Konto einrichten
- Eigenschaften von Artikeln einrichten
- allgemeine Modul-Konfiguration
- Artikel-Preisregeln konfigurieren
- Cronjob einrichten
- Übersetzungen & Sprachen
- Modul-Kompatibilität
- Lizenz
- Fazit/ Downloads
Einführung
Edelmetallpreise in Echtzeit
Dieses PrestaShop Modul erlaubt es den aktuellen Gold- und Silberkurs über eine Schnittstelle zum Anbieter Goldapi.io abzufragen und damit den Preis für Edelmetall-Artikel wie Goldmünzen, Goldbarren, Silbermünzen und Silberbarren automatisch zu aktualisieren.
Funktionsübersicht
- Produktpreise mit goldapi.io verbinden
- Konfiguration von API-Key, Eigenschaften und Eigenschaftenwerte für die Edelmetalle Gold und Silber
- Sicherheitssperre für starke Preisschwankungen
- Log für Artikelpreis-Aktualisierungen
- Cronjob für automatische Preisaktualisierung
- Fehler-Meldungen per E-Mail
- Loglevel und Ansicht von Logdateien über Modul-Konfiguration
Installation
7 Schritte zur einfachen Modulinstallation
- Gehen Sie im PrestaShop Backoffice zur Modulverwaltung (ehemals Modul-Manager) und klicken Sie auf „Modul hochladen“
- Ziehen Sie nun die Moduldatei (zip-Datei) per Drag & Drop oder wählen Sie
die Datei im System-Verzeichnisbaum aus - Wählen Sie die hochzuladende ZIP-Datei aus und klicken Sie auf "OK"
- Ihr Modul wird installiert und erscheint in der Liste der installierten Module
- Warten Sie bis die Modulinstallation erfolgreich abgeschlossen ist
- Um mit der Einrichtung zu beginnen, klicken Sie auf "Konfigurieren". Wenn Sie mehrere Shops haben, müssen Sie jeden Shop separat konfigurieren. Bitte wählen Sie Ihren Shop direkt aus dem Menü aus, mit dem Sie beginnen möchten.
- Testen Sie das Modul: Gehen Sie zur Frontend-Ansicht Ihrer Website und überprüfen Sie, ob das Modul wie erwartet funktioniert.
Viel Erfolg!
Einrichtung
GoldAPI Konto einrichten
Sie benötigen für die Nutzung der Gold-API ein gültiges und aktives Google Konto.
Gehen Sie zur Seite https://www.goldapi.io/ und klicken Sie auf den Button "GET FREE API KEY OR SIGN IN"
Danach werden Sie aufgefordert sich mit Ihren Google-Kontodaten einzuloggen. (Erst E-Mail oder phone, dann im zweiten Schritt das Passwort eingeben)
Danach sind Sie eingelogged und können direkt den API-KEY einsehen und kopieren.
Eigenschaften von Artikeln einrichten
Gehen Sie in Ihrem PrestaShop Back Office auf Katalog > Varianten & Eigenschaften (1) > Eigenschaften (2)
Dort klicken Sie auf den Button "Neue Eigenschaft hinzufügen" (3) und ergänzen die Eigenschaft "Edelmetall" (4).
Danach die neuen Eigenschaftswerte für Gold und Silber hinzufügen:
Für Silber analog verfahren. Damit sind wir vorbereitet, das Modul einzustellen.
allgemeine Modul-Konfiguration
Wichtig ist hier, dass ein gültiges Konto bei GoldAPI.io existiert und die Eigenschaftswerte für Gold und Silber bereits angelegt wurden.
Einstellungen
1) API-Key
Der API-Key wurde im vorherigen Kapitel bereits kopiert und kann jetzt hier in der Konfiguration eingetragen werden
2) Eigenschaft Edelmetall
Die Eigenschaft wurde im vorherigen Kapitel bereits angelegt und muss hier ausgewählt werden
3) Eigenschaftwert Gold
Der Eigenschaftswert Gold wurde im vorherigen Kapitel bereits angelegt und muss hier ausgewählt werden
4) Eigenschaftwert Silber
Der Eigenschaftswert Silber wurde im vorherigen Kapitel bereits angelegt und muss hier ausgewählt werden
5) Maximale Änderung (in %)
Dies ist ein Sicherheits-Merkmal des Moduls. Hier wird eine Zahl eingegeben, die bestimmt, wie hoch Preisschwankungen akzeptiert werden. Wenn dieser Wert bei einem Cronaufruf überschritten wird, dann wird der Preis im Shop nicht aktualisiert und der Shopbetreiber erhält per E-Mail eine Nachricht.
Beim initialen Einrichten der Artikel empfiehlt es sich, diesen Wert auf eine sehr hohe Zahl zu setzen und erst später im Livebetrieb diesen Wert sukzessive an die eigenen Sicherheitsbedürfnisse anzupassen.
6) Produktpreise ins Log schreiben
Bei „Ja“ werden alle Preisänderungen in einer Log-Datei protokolliert, siehe Protokolleinträge / Log Einstellungen unten
7) Cron-Fehler E-Mail
Falls Sie über Fehler per E-Mail benachrichtigte werden möchten, geben Sie hier bitte eine gültige Mailadresse ein.
Cron Infos
Die Einstellungen zum Cronjob werden separat im übernächsten Kapitel beschrieben
Log Einstellungen
1) Loglevel
In diesem Dropdown wird das Log-Level festgelegt. Das sind interne Loglevel, die in der Programierung verschiedene Log-Mengen in das Log schreiben. NONE schaltet das Log ganz aus, DEBUg erzeugt die meisten und Emergency die wenigsten Log-Einträge.
2) Logdateien
Die Logdateien sind mit einem Zeitstempel versehen.
- admin-Logdateien wurden durch das Back Office erzeugt
- cron durch den Cronjob
- install und uninstall Logs erscheinen bei den Installations- und Deinstallationsvorgängen
3) Logdateien löschen
Artikel-Preisregeln konfigurieren
Eigenschaft dem Artikel zuweisen
Im Reiter "Allgemein > Eigenschaften" weisen Sie dem Produkt die Eigenschaft "Edelmetall" und den passenden Eigenschaftwert "Gold" oder "Silber" zu:
Damit steht die Zuordnung, welcher Typ Preis bei der Preisaktualisierung gezogen werden soll.
Preise
Im Reiter "Preise" finden Sie daraufhin die Einstellungen für den individuellen Preisaufschlag bezogen auf das Edelmetall.
- Bei Gold-Artikeln sind Rahmen und Button in Gold eingefärbt
- Bei Silber-Artikeln sind Rahmen und Button in Silber eingefärbt
1) Spot-Preis-Anzeige
Neben der Goldapi-Überschrift finden Sie die aktuellen Spot-Preise für Gold und Silber und können daraufhin die Auswirkung auf den Endpreis besser abschätzen.
2) Preise abrufen
Preisauswirkung
a) Keine
Wenn bei der Auswirkung nichts ausgewählt wird, dann wird der Produktpreis nicht angepasst. Sie können einen fixen Preis festlegen, bei der API eine neuen Spot-Preis anfordern (1), das Spotpreis-Update wird kurz angezeigt (2), der zuvor festgelegte Preis ändert sich nicht (3).
b) Prozentsatz
Der Prozentsatz eignet sich, wenn Sie auf ganze Unzen einen Preisaufschlag in Prozent definieren möchten. Das geht schnell und ist aber nur bei ganzen Unzen sinnvoll. Hierbei wird der prozentuale Aufschlag definiert (1), der Preis abgerufen (2) und der berechnete Preis wird hier direkt eingetragen (3).
c) Betrag
Der Betrag verhält sich ähnlich, nur dass hier statt dem Prozentsatz ein Festwert (1) eingetragen wird. Dabei kann gewählt werden, ob der Wert inkl. oder zzgl. MwSt. (2) in die Berechnung einfließen soll. API abrufen (3) und der Preis wird aktualisiert (4)
d) Formel
Die wichtigste und mächtigste Funktion ist die Formel, denn hierbei lassen sich ganz individuell Preisaufschläge modellieren.
Die Variable {sport} muss Bestandteil der Formel sein und ist der Wert des aktuellen Spotpreise des gewählten Edelmetalls.
In diesem Beispiel wird der Spotpreis doppelt genommen (für 2 Unzen) und mit einem zusätzlichen Aufschlag von 100 berechnet (1). Auch hier kann man zwischen zzgl. MwSt. und Bruttopreis wählen (2), den neuen Preis abrufen (3) und die Formel wird bei der Neuberechnung des Endpreises berücksichtigt (4).
Cronjob einrichten
Cron Infos
Der Cron Aufruf kann entweder per Wget oder über den PHP Interpreter aufgerufen werden. Bitte prüfen Sie bei Ihrem Provider, wie Crons eingerichtet werden.
1) Cron Aufruf per Wget
Hier wird die hier angegebene URL per Wget auf dem Server ausgeführt. Dieser Aufruf wird zum Beispiel über die CLI (Command Line Interface / Shell) direkt auf dem Server ausgeführt.
2) Cron Aufruf per PHP Interpreter
Dieser Aufruf kann direkt über den PHP Interpreter über die CLI (Command Line Interface / Shell) direkt auf dem Server ausgeführt und kann so in eine Crontab eingetragen werden.
3) Cron Aufruf per Button
Wen Sie diesen Button anklicken wird der Cron-Aufruf umittelbar in einem neuen Browsertab ausgeführt. Sie können per Rechtsklick auf den Button auf die Cron-URL kopieren, um den Link z.B. in Plesk bei den geplanten Aufgaben zu hinterlegen.
Im Plesk stellen Sie den Cronjob dann auf "Fetch a URL" und geben im Feld "URL" den kopierten Link ein.
4) Cron läuft auf Wartung
Führen Sie Cronjobs aus, auch wenn der Wartungsmodus in Ihrem Shop aktiviert ist. Ansonsten wird der Aufruf nicht erfolgreich sein.
Übersetzungen & Sprachen
Übersetzungen
Die Übersetzungen können direkt in der Modulkonfigurationsansicht vorgenommen werden. Klicken Sie dazu einfach auf Übersetzen und wählen Sie anschließend die gewünschte Sprache aus. Zur Auswahl stehen alle von Ihnen installierten Sprachen. Deutsch und Englisch werden mit dem Modul mitgeliefert.
Modul-Kompatibilität
Kompatibilität mit PrestaShop
GoldAPI für PrestaShop 8
- kompatibel mit PrestaShop 8.x ab Version 8.x.
- mindestens PHP 7.1
GoldAPI für PrestaShop 1.7
- kompatibel mit PrestaShop 1.7.x ab Version 1.7.8.6.
- mindestens PHP 7.1
Hinweis: Falls Sie eine PrestaShop 1.7. Version nutzen, können die Screenshots lt. dieser Dokumentation abweichen.
Lizenz
Lizenz Gold API Modul
- Das Modul unterliegt einer kommerziellen Lizenz. Sie dürfen das Modul auf einer Domain installieren.
- Zu Test- und Debugzwecken ist keine weitere Lizenz notwendig.
- Nach Bestellung können Sie die Domain lizenzieren, unter der das Modul verwendet wird.
- In Ihrem Kundenkonto können Sie Ihre Lizenzen unter dem Link "Meine Lizenzen" verwalten.
Fazit/ Downloads
Verwalten Sie Edelmetallkurse durch Echtzeitanbindung an GoldAPI.io. Edelmetallpreise unterliegen an der Börse ständigen Schwankungen und können sich daher innerhalb von Minuten stark verändern. Dieses Tool unterstützt Sie bei einer soliden Preiskalkulation.
Hilfreiche Links und Downloads
Download Gold API für PrestaShop 8
(zur Zeit nur auf Anfrage verfügbar)
Hinweis
Bitte beachten Sie, dass diese Dokumentation eine Momentaufnahme darstellt und sich von älteren oder zukünftigen Versionen unterscheiden kann. Wir sind darum bemüht, unsere Dokumentation aktuell zu halten. Bei Rückfragen oder Unsicherheiten stehen wir Ihnen jederzeit gerne zur Verfügung.
Hilfreiche Links
Goldapi.io
Anbieter der Wechselkurs-Schnittstelle für Edelmetalle
Falls Sie Unterstützung bei der Optimierung Ihres PrestaShop-Shops benötigen, zögern Sie nicht, Gurkcity zu kontaktieren. Unser Support-Team steht Ihnen nicht nur bei der Modulinstallation zur Seite, sondern bietet Ihnen auch umfassende Dienstleistungen als PrestaShop Full-Service-Agentur an.