Shoporama Apps
Nachfolgend finden Sie Informationen zur Entwicklung von Shoporama-Apps
Menü
1 Auf einen Blick
Insgesamt bietet eine Shoporama-App Zugang zu zwei Dingen, wenn ein Nutzer sie in seinem Shop installiert:
REST-interfacet
at indsætte kode på udvalgte sider
Jeder kann Apps erstellen, aber damit andere Geschäfte Ihre Apps nutzen können, müssen Sie zugelassen werden.
2 Einstellungen und Präferenzen
Die Einstellungsmöglichkeiten für Anwendungen sind
| Feld | Inhalt |
|---|---|
| Name | Kurzer Name. Wird in Übersichten und E-Mails verwendet. |
| Beschreibung | Längere Beschreibung dessen, was Ihre Anwendung tut. Es ist nicht möglich, HTML-Codes zu verwenden. Nur a-Tags für Links. |
| Kategorie | Fakultative Kategorie |
| Zugang zu | Da Ihre Anwendung im Shop, der die Anwendung installiert, ein Api-Token erstellt, können Sie wählen, ob Sie Schreib-, Lese- oder alle Rechte für dieses Api-Token haben möchten. |
| Preis pro Monat | Ein monatlicher Preis, den Ihre App kostet. Es wird eine 80/20-Aufteilung vorgenommen, bei der Shoporama 20% behält und den Rest auszahlt. Sobald eine App auf aktiv geschaltet ist, können Sie den Preis nicht mehr erhöhen. Nur nach unten. |
| Rückruf-URL |
Eine URL, die alle Rückrufe und Ereignisse empfangen kann. Das Argument Wenn Ihre Anwendung Felder verwendet, in die der Benutzer Informationen eingeben kann, werden diese in das Feld Bei Ereignissen und Webhooks enthält der Aufruf die in unseren Ereignissen und Webhooks enthaltenen Daten. Diese variieren, ob es sich um Ereignisse oder Produkte, Bestellungen usw. handelt. Um zu überprüfen, ob ein Rückruf von Shoporama stammt, fügen wir allen unseren Aufrufen den Header |
| Nur in den folgenden Geschäften erlaubt | Option, um die App nur für eine Reihe von Webshops zuzulassen. |
| Webhaken | Hier wählen Sie aus, welche Webhooks Sie erhalten möchten. Sie können Webhooks empfangen, wenn Änderungen an Aufträgen (Status, bezahlt, erstellt), Produkten oder Lagerbeständen vorgenommen werden. |
| Veranstaltungen |
Hier wählen Sie aus, welche Ereignisse Sie erhalten möchten. Ereignisse können häufiger als Webhooks gesendet werden, z. B. wenn ein Benutzer etwas in den Warenkorb legt oder zur Kasse geht. Wir haben die folgenden Ereignisse: add_to_basket
update_basket
view_basket
view_address
view_shipping
view_approve
view_thanks
approved
order_created
paid
add_label
remove_label
|
3 REST-Zugang
Wenn eine App in einem Shop installiert wird, wird ein Api-Schlüssel für die App erstellt und mit diesem Schlüssel können Sie auf unsereRest-Schnittstelle für den betreffenden Shop zugreifen. Api-Schlüssel werden alsapp_token-Feld an Ihre Callback-URL gesendet. Beachten Sie, dass für den Api-Zugang dieselben Regeln gelten wie für reguläre Api-Schlüssel in Bezug auf die Verwendung.
Zusätzlich zum Zugriff auf unsere reguläre Schnittstelle ist es möglich, eine Liste der Webshops abzurufen, die Ihre App installiert haben:
GET /REST/app-status HTTP/2
Host: www.shoporama.dk
Authorization: App {din token}Beachten Sie, dass auth-scheme die App.
4 Code einfügen
Es ist möglich, den Code an vier Stellen in den Shops einzufügen, die die App installieren:
<head>
<body>
</head>
</body>
Es ist möglich, den Code auf allen Seiten oder nur auf Produkten, Landing Pages, Kategorien, statischen Seiten, Blogposts oder auf /search, /basket, /address, /shipping, /approve, /thanks, /order und /also einzufügen.
Es ist möglich, Smarty-Code im eingefügten Code zu verwenden, und es ist möglich, auf die vom Benutzer in Felder wie <{$app_vars.var_name}> eingegebenen Werte zuzugreifen .
Die oben genannten Elemente können beliebig kombiniert werden, so dass es möglich ist, ein Stück Code in <head>auf allen Seiten einzufügen, aber auf /thanks möchten Sie etwas Zusätzliches hinzufügen.
5 Felder
Mit Fields können Sie einige Eingabefelder erstellen, die Ihre Nutzer bei der Installation der App ausfüllen können. Sie können so viele Felder erstellen, wie Sie möchten. Die Werte werden in Rückrufe aufgenommen, wenn der Benutzer die Einstellungen aktualisiert.
Wir unterstützen die folgenden Feldtypen:
text
integer
boolean
list
color
richtext
code
Externe Felder
Sowohl für Text- als auch für Listenfelder ist es möglich, externe Werte zu verwenden.
Externe Listen
Bei Listen werden die Werte aus https://example.com/callback?type=field&name={name} gezogen und sollten json im Format key:value zurückgeben:
{
"key1": "value1",
"key2": "value2"
}Externe Textfelder
Bei Textfeldern wird der Wert von der gleichen URL wie bei Listen abgerufen. Der Wert wird dem Benutzer als schreibgeschützt angezeigt. Das Format kann entweder eine einfache Textzeichenfolge oder JSON sein:
{
"value": "tekst værdi"
}Oder geben Sie direkt eine einfache Textzeichenfolge zurück.