leadprint REST-Schnittstelle
leadprint REST-Schnittstelle
Modul leadprint REST-Schnittstelle zu LC Business Pro 3.5M
Das Thema WEBshops ist ein nicht mehr zu unterschätzendes Faktum im heutigen Geschäftsleben. Der Online-Handel nimmt permanent zu und macht auch vor uns Dienstleistern nicht halt. Gerade als Kundenbindungselement erfreuen sich kundenspezifische WEBshops immer größerer Beliebtheit.
Warum bieten Sie Ihren Kunden nicht eine entsprechende Plattform, auf der beispielsweise Visitenkarten, Flyer, weitere Druckprodukte oder auch Werbeartikel online personalisiert und online bestellt werden können. Denken wir mal an eine Firma, die über zahlreiche Mitarbeiter und Niederlassungen verfügt. Stellen Sie dieser Firma ihren WEBshop zur Verfügung, in der die Visitenkarten und Marketingunterlagen von jedem Mitarbeiter in vorgegebenen Designgrenzen erstellt und bestellt bzw. abgerufen werden können.
Und bietet LEOconcept eine solche Plattform? Klare Anwort: NEIN ... da es bereits ein perfektes Produkt für diesen Bereich am Markt gibt. Der Marktführer in diesem Bereich - die Firma leadprint - verfügt bereits über entsprechende Lösungen, die über einen Zeitraum von über 12 Jahren erstellt und permanent weiterentwickelt wurden.
»leadprint steht für kundengruppenspezifische Web To Print Lösungen – bedarfsgerecht und bezahlbar.« sagt André Hausmann - der Geschäftsführer von leadprint. Zahlreiche Industrie- und Franchiseunternehmen sowie Konzerne zählen heute zum Kundenstamm. Mit über 320 Installationen innerhalb Druckereien und Werbeagenturen in Deutschland und Europa und über 1800 aktiven B2B-Portalen für Franchise, Industrie und Handel, partizipieren leadprint-Kunden nicht nur von einem kundenorientierten kostenfreien Support und einer sicheren und redundanten IT, sondern auch von den Erfahrungen der Firma leadprint in der Betreuung von einfachen bis zu hoch komplexen WebToPrint Projekten.
Warum also selbst eine Web To Print - Lösung in LC Business Pro integrieren, wenn es bereits eine Lösung am Markt gibt, die alle Anforderungen abdeckt.
Stellt sich die Frage, wie die Aufträge aus dem leadprint-WEBshop in das LC Business Pro kommen. leadprint stellt im Grunde genommen zwei Benutzeroberflächen zur Verfügung. Ein WEBbasiertes FrontEnd für den Endkunden und ein BackEnd für die Administration der WEBshops. Damit haben wir noch keine Verbindung zwischen LC Business Pro und dem WEBshop.
Und hier die Lösung:
leadprint REST-Schnittstelle
Hauptmerkmale
- Übernahme von leadprint-Aufträgen aus beliebig vielen »leadprint-closed-shops« via REST-Schnittstelle.
- Voraussetzung: Freischaltung leadprint REST-Schnittstelle seitens leadprint
- Voreinstellungen im Admin-Bereich
- Abrufportal für leadprint WEBshop Importe
- Sammelabruf aller für Sammelabruf gekennzeichneten Shops
- automatisierte Anlage aller selektierten Aufträge aus den WEBshops als LC Business Pro - Aufträge
LC Business Pro & leadprint
leadprint stellt eine sogenannte REST-Schnittstelle zur Verfügung. REST steht für Representational State Transfer und beschreibt eine Art Standardschnittstelle, die über HTTP läuft. Damit haben unterschiedliche Systeme die Möglichkeit, »miteinander zu reden« und automatisiert einen Austausch von Informationen vorzunehmen.
Das LC Business Pro nutzt diese Möglichkeit, um automatisiert Aufträge abzurufen und im LC Business Pro weiter zu verarbeiten. Es ist keine zeitaufwendige Eingabe oder der Import von Excel-Listen notwendig, die möglicherweise fehlerbehaftet sind, weil im hektischen Tagesgeschäft Fehler passieren können. Abgerufen werden können beliebig viele leadprint-WEBshops.
Voraussetzungen zur Nutzung dieser Möglichkeit:
• Freischaltung der REST-Schnittstelle in den leadprint-WEBshops
• Freischaltung der REST-Schnittstelle im LC Business Pro
Zu kompliziert? Schwer umsetzbar bezüglich der Einrichtung bzw. Administration? Auf keinen Fall! Innerhalb der beiden Systeme steht ein entsprechendes »User-Interface« zur Verfügung, über welches sich die Kommunikationsparamter für beiden Systeme intuitiv einstellen lassen.
leadprint REST-Schnittstelle - Voreinstellungen in leadprint-WEBshops
Im Admin-Bereich jedes Ihrer leadprint-WEBshops aktivieren Sie unter »Api« die REST-Schnittstelle, indem Sie die Funktion aktivieren und einen API-User - einen Benutzer - und einen API-Key - also ein Kennwort für diesen Benutzer vergeben.
Die leadprint REST-Schnittstelle im LC Business Pro benötigt folgende Informationen für die Kommunikation:
• Adresse des Shops - URL: z.B. https://www.testshop.de
• API-User: z.B. restuser1234
• API-Key: z.B. #abc56yxs?1BB
Achtung! Für jeden im LC Business Pro abzurufenden leadprint-WEBshop benötigt LC Business Pro genau diese Zugangsdaten.
leadprint REST-Schnittstelle - Voreinstellungen in LC Business Pro
Im Admin-Bereich steht ein eigener Bereich für die leadprint REST-Voreinstellungen zur Verfügung. Im Grunde genommen handelt es sich hier um die Eingabemöglichkeit der Zugangsdaten zu den leadprint-WEBshops sowie einige Zusatzeinstellungen.
Mit nur einem Klick gelangen Sie in diese Voreinstellungen.
Drei Bereiche stehen für die Voreinstellungen zur Verfügung:
• leadprint WEBshops
• leadprint Stati
• leadprint Infos REST-Schnittstelle
leadprint WEBshops
Hier werden die leadprint-WEBshops für den automatisierten Abruf von Aufträgen angelegt.
Erstellen Sie einen neuen abzurufenden WEBshop über den Knopf »NEUER leadprint-WEBshop«. Vergeben Sie einfach einen LEO-internen Namen für den WEBshop - z.B. das Kundenkürzel des Endkunden und geben die Adresse - URL - des WEBshops sowie Api-User und Api-Key an.
Die Folge gibt an, in welcher Reihenfolge die WEBshops später angezeigt werden. Sie ändern die Folge, indem Sie die Zahlen entsprechend modifizieren und falls einmal die Zwischenräume ausgehen, nutzen Sie den Knopf »Folge reorganisieren«. Das System vergibt dann die Folgen in Zehnerschritten entsprechend der aktuellen Reihenfolge.
Der Knopf »Sammelabruf« für jeden Shop bewirkt, dass der jeweilige Shop in einen möglichen Sammelabruf einbezogen wird - Schalter »grün« - oder nicht einbezogen wird - Schalter »rot«.
leadprint Stati
leadprint-WEBshops arbeiten für die verschiedenen Auftragszustände mit Auftragsstati, die über diese Voreinstellung angezeigt werden. LC Business Pro nutzt diese Stati, um die jeweils gewünschten Aufträge abrufen zu können.
Darüber hinaus stehen hier einige Einstellmöglichkeiten zur Verfügung:
Die »Maximale Anzahl von Aufträgen pro Abruf« lässt sich einstellen. Ein Standard wäre z.B. 20 ....
Wird von einem Endkunden ein Auftrag im leadprint-WEBshop angelegt, hat der Auftrag automatisch den Order-Status 61 - in Produktion. Aus diesem Grunde gibt es die Möglichkeit, den Standard Abruf-Status zu setzen. Neue Aufträge werden in der Folge mit dem Filter 61 im Order-Status abgerufen.
Damit Aufträge aus dem leadprint-WEBshop nicht permanent erneut und damit doppelt abgerufen werden, bietet das System die Möglichkeit, den Order-Status automatisiert zu modifizieren. Hier stehen zwei Varianten zur Auswahl:
• Änderung Order-Status nach Abruf
• Änderung Order-Status nach Auftragsanlage im LC Business Pro
In der Regel wird nur eine Änderung notwendig. Also beispielsweise bei Aufruf die Änderung auf den Status 117 - erledigt. Mit dem Filter 61 ruft LC Business Pro beim nächsten Abruf nur die neuen Aufträge ab.
Natürlich lässt sich der Filter vor jedem Abruf auch manuell setzen, um bereits abgerufene Aufträge erneut abrufen zu können.
leadprint Infos REST-Schnittstelle
An dieser Stelle erhalten Sie technische Hintergrundinformationen zur REST-Schnittstelle, zur API-Authentifizierung sowie weitere Hinweise für die Einstellungen der Schnittstelle im LC Business Pro.
Der Start der REST-Schnittstelle im LC Business Pro erfolgt über den Knopf »leadprint WEBshop Importe öffnen« auf dem »Home«-Bildschirm oder über das Auftragsmenü. Es öffnet sich ein neues Fenster »leadprint WEBshop Importe«.
Angezeigt werden alle aktuell bestehenden leadprint-WEBshops auf der linken Seite sowie die Abrufe der einzelnen WEBshops auf der rechten Seite.
Einen neuen Abruf starten Sie mit einem Klick auf den jeweiligen WEBshop auf der linken Seite. LC Business Pro stellt dann die Verbindung zum WEBshop her und ruft die neuen Aufträge ab. Sollten neue Aufträge verfügbar sein, werden diese nach erfolgtem Abruf direkt angezeigt.
Über den Knopf »Sammelabruf aller WEBshops starten« werden alle für einen Sammelabruf in den Voreinstellungen qualifizierten WEBshops der Reihe nach abgerufen, d.h. mit nur einem Klick werden beliebig viele WEBshops auf neue Aufträge überprüft und diese bei Verfügbarkeit direkt abgerufen.
Dokumentiert wird, welcher WEBshop von wem zu welcher Zeit abgerufen wurde. Des Weiteren wird die Anzahl der Aufträge sowie die darin enthaltenen Positionen angezeigt.
Ein Klick auf Meldungen zeigt sofort Fehler- und Statusmeldungen vom Abruf. Die Buchstabenkombinationen - z.B. KRSKUW - beschreibt den Abruf des entsprechenden leadprint-Aufträge.
Mit einem Sammelabruf können beliebig viele WEBshops abgerufen werden. Jeder WEBshop kann beliebig viele neue Aufträge enthalten und jeder Auftrag kann aus beliebig vielen Auftragspositionen bestehen. Da stellt sich die Frage, wie lässt sich die Fülle an Informationen übersichtlich darstellen, ist doch die Fläche selbst des größten Monitors irgendwann erschöpft.
Aus diesem Grunde arbeitet LC Business Pro mit einer Art Ebenenmodell, welches intuitiv bedient wird. Jeweils ein Klick auf das I - für Information - führt in die tiefere Ebene, der »Zurück«-Knopf führt in die vorherige Ebene.
So klickt man sich vom Abruf in die abgerufenen Aufträge, von dort in den einzelnen Auftrag und - falls gewünscht - von dort weiter in die einzelne Auftragsposition.
Gehen wir die einzelnen Schritte für einen Abruf einmal durch:
a) Start des Abrufes eines einzelnen WEBshops oder eines Sammelabrufes mit dem entsprechenden Klick
Das System gibt eine Rückmeldung, sobald der Abruf gestartet ist ...
Je nach Menge der abzurufenden WEBshops bzw. der Menge an Aufträgen kann es ein wenig dauern.
Sobald der Abruf beendet ist und mindestens ein neuer Auftrag gefunden und abgerufen wurde, zeigt das System alle neu abgerufenen Aufträge - im Grunde genommen bereits die zweite der oben beschriebenen Ebene.
Zu jedem Auftrag stellt das System zahlreiche Informationen zur Verfügung, die vermutlich selbsterklärend sind. Wichtig an dieser Stelle ist, dass alle Aufträge aus dem WEBshop automatisch für die Anlage im LC Business Pro selektiert werden. Erkennt LC Business Pro, dass ein abgerufener Auftrag bereits im LC Business Pro angelegt wurde, wird - wie in diesem Bild bei jedem Auftrag - der jeweilige Auftrag nicht selektiert und die zugehörige Auftragsnummer aus dem LC Business Pro angezeigt.
Ein Klick auf das I - für Information - führt eine Ebene tiefer und gibt den Blick frei auf Detailinformationen zum entsprechenden Auftrag.
b) Detailansicht zum einzelnen Auftrag
Das System zeigt Informationen zur Liefer- und Rechnungsanschrift sowie die zwei zum Auftrag gehörenden Positionen.Ein Klick auf das I - für Information - zeigt Informationen zum Auftragspositionsdetail.
c) Detailansicht zur einzelnen Auftragsposition
Über den »Zurück-Knopf« links oben gelangt man zurück in die vorige Ebene.
d) Automatisierte Auftragsanlage im LC Business Pro
Die automatisierte Anlage der WEBshop-Aufträge erfolgt über den Knopf »Aufträge anlegen«.
Das System berücksichtigt alle Aufträge, die selektiert und noch nicht im LC Business Pro angelegt wurden.
Sobald die Auftragsanlage gestartet ist, gibt das System eine entsprechende Rückmeldung.
Nach erfolgreicher Auftragsanlage werden alle neu angelegten Aufträge im Hauptfenster des LC Business Pro dargestellt.
Im Fenster »leadprint WEBshop Importe« wurde jeder angelegte Auftrag gekennzeichnet. Darüber hinaus wird die LC-Auftragsnummer angezeigt.
Eine erneute Auftragsanlage eines bereits angelegten Auftrag ist nur dann möglich, wenn der Auftrag - beispielsweise 22/1093 - im LC Business Pro vorher gelöscht wurde.
Zu komliziert? Nein, sicher nicht ...
Grundsätzlich sind nur zwei Aktionen notwendig:
• Abruf eines WEBshops oder Sammelabruf ... und danach
• Aufträge anlegen
Fertig! Alle weiteren Ansichten stehen lediglich bei Bedarf zur Verfügung und dienen der möglichen Kontrolle.
Eine komplexe Geschichte diese leadprint REST-Schnittstelle im LC Business Pro, folgt allerdings auch wieder einer gewissen Logik. Und wenn die ersten Aufträge aus dem WEBshop abgerufen und im LC Business Pro angelegt worden sind, läuft es auch ohne Anleitung ... :-)
Ihr Vorteil
... große Zeitersparnis und Vermeidung von Übertragungsfehlern wie bei beispielsweise manueller Auftragsanlage.