Zum Hauptinhalt springen

Netzwerk-Modul (API)

Das Netzwerk-Modul bietet eine vereinfachte Verwaltung der Produktdaten für Hersteller, die mehrere Foodcoops beliefern.

Achtung

Die Versionen 3.2.0 bis 3.6.0 enthalten eine Sicherheitslücke im Netzwerk-Modul. Bitte updaten! Jede Remote-Foodcoop muss auch die Master-Foodcoops als Remote-Foodcoop anlegen.

tipp

Das Netzwerk-Modul stellt auch eine API zum Abrufen der Bestellungen zur Verfügung. Sie ist für alle Hersteller nutzbar.

Funktionen / Konfiguration​

  • Es ist dadurch möglich, die verteilten Produktdaten der verschiedene Foodcoops synchron zu halten. Die Daten werden dafür nicht auf einem einzigen Server zentral gespeichert, das ist wichtig für die (technische) Unabhängigkeit der Foodcoops.
  • Jede Foodcoop muss zur Verwendung des Netzwerk-Moduls immer die aktuellste FoodCoopShop-Version installiert haben und ein SSL-Zertifikat (https) verwenden.
  • Die Produktdaten Bild, Name inkl. Beschreibungen, verfügbare Menge, Preis, Pfand, Lieferrhythmus und Status können von einer sogenannten Master-Foodcoop auf beliebig viele Remote-Foodcoops übertragen werden. Das spart vor allem bei wöchentlichen Sortimentsänderungen viel Zeit.
  • Dafür notwendig: einmalige Zuordnung von bereits bestehenden Produkten und Varianten zwischen Master-Foodcoop und Remote-Foodcoop(s)
  • Hersteller, die ihre Produkte bereits bei einer Foodcoop eingepflegt haben und eine neue Foodcoop beliefern, können ihre Produkte mit dem Netzwerk-Modul schneller neu anlegen. Details dazu unter Punkt 5.
  • Nur Hersteller können mit dem Netzwerk-Modul arbeiten, Admins bzw. Superadmins können es nicht verwenden.

Aktivierung​

  • Das Netzwerk-Modul ist standardmäßig deaktiviert. Die Aktivierung des Netzwerk-Moduls für die Verwendung als Master- und/oder Remote-Foodcoop erfolgt über die Datenbank: In der Tabelle fcs_configuration das Feld value für name=FCS_NETWORK_PLUGIN_ENABLED auf 1 setzen.

Technische Ausdrücke​

  • Master-Foodcoop: Foodcoop, auf der die Produkt-Zuordnungen stattfinden. Jede Foodcoop kann als Master-Foodcoop verwendet werden. Empfehlenswert ist es, immer die gleiche Foodcoop als Master-Foodcoop zu verwenden, da sonst die Produkt-Zuordnungen mehrfach gepflegt werden müssen.
Achtung

Wenn eine Foodcoop den variablen Mitgliedsbeitrag verwendet (x % Aufschlag), so kann diese Foodcoop nicht als Master-Foodcoop verwendet werden! Als Remote-Foodcoop kann sie aber schon verwendet werden.

  • Remote-Foodcoop: Foodcoop, auf der die Daten der Master-Foodcoop übertragen werden. Das können auch mehrere sein.

1. Remote-Foodcoops erstellen​

In den Einstellungen können Superadmins Remote-Foodcoops erstellen und bearbeiten.

Seit dem Sicherheits-Update (v3.6.1) müssen auch alle Master-Foodcoops, von denen aus die Daten synchronisiert werden, als Remote-Foodcoops angelegt werden.

2. Remote-Foodcoops für Hersteller auswählen​

Der Hersteller selbst (oder ein Superadmin) kann in den Hersteller-Einstellungen dann diese in Punkt 1 erstellten Remote-Foodcoops auswählen. Mit ihnen kann er dann seine Produktdaten synchronisieren.

3. Produktdaten synchronisieren​

  • Wenn der Hersteller (oder ein Superadmin) in den Hersteller-Einstellungen mindestens eine Remote-Foodcoop ausgewählt hat, befindet sich im Hersteller-Login unter "Meine Produkte" oben rechts ein neuer Button Produkte synchronisieren.

  • Ein Klick darauf bringt dich zur Übersicht, von der aus du deine Produktdaten auf die Remote-Foodcoops übertragen kannst. Dafür müssen allerdings zuvor die Produkte und Varianten der Remote-Foodcoops mit den Produkten der Master-Foodcoop zugeordnet werden - siehe Punkt 4.

  • Ein Klick auf Vorschau laden (erfolgt automatisch, falls du die Zugangsdaten bereits einmal eingegeben hast) zeigt dir, welche Unterschiede bei den Produktdaten deiner Foodcoops bestehen. Rot hinterlegte Felder weisen auf einen Unterschied hin. Wenn du die Checkbox Nur Produkte mit Abweichungen anzeigen deaktivierst, kannst du dir auch jene Produkte anzeigen lassen, die bereits auf allen Foodcoops abgeglichen sind.

  • Durch Auswählen der Häkchen kannst du festlegen, welche Produktdaten (horizontale Häkchen) und welche Produkte (vertikale Häkchen) synchronisiert werden sollen. Produkte, die keine Unterschiede aufweisen, können nicht ausgewählt werden.

  • Klicke jetzt auf Produkte synchronisieren, um die Daten der Master-Foodcoop zu übertragen. Nach dem Synchronisieren wir die Vorschau automatisch aktualisiert.

4. Produkte zuordnen​

  • Trage in den Login-Formularen oben deine Zugangsdaten für die entsprechenden Foodcoops ein und klicke auf Produkte laden.
  • Die Produkte der Remote-Foodcoops werden jetzt in den orange umrahmten Tabellen angezeigt. Du kannst sie durch "Drag and Drop" auf die Produkte der grün umrahmten Tabelle ganz links ziehen, um die Produkte zuzuordnen.
  • Das Netzwerk-Modul legt keine Produkte neu an, es können nur bereits bestehende Produkte verknüpft werden - siehe auch 5). Gegebenfalls musst du dich bei den anderen Foodcoops einloggen und fehlende Produkte neu anlegen, dann erneut auf "Produkte laden" klicken und dann zuordnen.
  • Achtung: Das Anmelden bei den Remote-Foodcoops über das Netzwerk-Modul erlaubt leider keine Sonderzeichen im Passwort. Falls das der Fall ist, muss es bei der Remote-Foodcoop geändert werden.
  • Varianten müssen immer einzeln zugeordnet werden.
  • Es ist nicht möglich, Varianten und Produkte miteinander zu verknüpfen. Z.B. wenn bei der Master-Foodcoop nur eine Variante "1 Liter" verwendet wird und und bei einer Remote-Foodcoop wird dazu das Feld "Einheit" (ohne Variante) verwendet. Die Daten-Struktur muss dafür angeglichen werden (z.B. Variante löschen).

5. Produkte für neue Foodcoop übertragen​

Es ist mit dem Netzwerk-Modul zwar (noch) nicht möglich, noch nicht vorhandene Produkte zu übertragen, mit folgender Vorgehensweise kann man aber seine Produkte viel schneller anlegen:

  • Auf der Remote-Foodcoop so viele leere Produkte anlegen, wie man benötigt
  • Gegebenfalls auch die Varianten dazu anlegen (Achtung: Die Variante selbst muss die richtige sein, sie wird nicht synchronisiert)
  • Dann auf die Master-Foodcoop wechseln und die leeren Produkte zuordnen.
  • Produktdaten synchronisieren - der Hersteller muss danach auf Remote-Foodcoop nur noch Bild, Kategorien, "als neu anzeigen" und Steuersatz anpassen.

6. API zum Abrufen von Bestellungen​

tipp

Hersteller können über folgenden Endpoint alle Bestellungen für einen bestimmten Abholtag abrufen. Das Netzwerk-Modul muss dazu aktiviert sein.

Authentifizierung

Die Authentifizierung erfolgt über BasicAuthentication mit den Base64-encoded Login-Daten des Herstellers (E-Mail, Passwort).

Headers

Content-Type:application/json
Authorization:Basic + Base64-String

Endpoint

GET https://www.example.com/api/orders.json?pickupDay={date}
PARAM pickupDay: Format: dd.mm.yyyy, Pflichtfeld

Response

app.name: string / Name der Foodcoop

app.domain: string / Domain der Foodcoop

app.orders.{n}.id: int / interne Order-Id

app.orders.{n}.product_id: int / interne Produkt-Id

app.orders.{n}.attribute_id: int / interne Varianten-Id (0 wenn das Produkt keine Varianten verwendet)

app.orders.{n}.name: string / Name des Produktes (Produkt ohne Preis nach Gewicht: Einheit ist getrennt mit " : ")

app.orders.{n}.amount: int / Wie oft wurde das Produkt bestellt? z.B. 1,

app.orders.{n}.order_state: int / 3=OPEN / 10=ORDER_LIST_SENT / 11=BILLED_CASHLESS / 12=BILLED_CASH

app.orders.{n}.created: date / Wann wurde die Bestellung getätigt?

app.orders.{n}.unit: array / Falls das Produkt mit Preis nach Gewicht verrechnet wird ist dieser Index nicht leer.

app.orders.{n}.unit.name: string / Einheit, z.B. "g"

app.orders.{n}.unit.mark_as_saved: boolean / Wurde das Gewicht bereits angepasst?