myfactory Online-Hilfe

SOAP API Konfiguration

myfactory hat eine allgemeine SOAP-API für den lesenden und schreibenden Datenaustausch mit anderen Systemen und Tools implementiert. Für einige über die SOAP API aufrufbare Methoden bzw. Funktionen können grundlegende Einstellungen in der myfactory-Anwendung festgelegt werden. Diese lassen sich mithilfe dieses Dialogs betriebsstättenübergreifend konfigurieren.

So können Sie diesen Webservice beispielsweise als Schnittstelle zur Deutschen Post bzw. DHL einsetzen, um myfactory-Adressdatensätze mit den Adressdaten der Deutschen Post / DHL abzugleichen. Ein weiteres Anwendungsszenario ist die Anbindung von Onlineshops über den SOAP-Webservice. Weiterhin lassen sich z.B. auch externe Tools zur Beleg- oder Lagerbestandsverwaltung über die SOAP-API mit der myfactory verknüpfen. Ein Vorteil dieser integrierten Schnittstelle besteht darin, dass auch Public Cloud-Kunden den Webservice für den Datenzugriff einsetzen können. Ein Zusatzmodul ist nicht notwendig.

Webservice-Zugang aktivieren

Um die SOAP-API verwenden zu können, muss zunächst der generelle Webservice-Zugang der myfactory für den lesenden und schreibenden Zugriff sowie das Adressieren von Business-Logiken aktiviert werden. Dies erfolgt einmalig über den ebenfalls unter dem Menü-Ast "Datenzugriff" auffindbaren Dialog "Webservice-Zugänge" ("Administration / Datenzugriff / Webservice-Zugänge"). Anschließend können Sie den Datenzugriff nochmals individuell pro Benutzer steuern und diesen entsprechend berechtigen oder ihm den Zugang verwehren. Ähnliches gilt bei den Berechtigungen für die über die SOAP-Schnittstelle möglichen Funktions- bzw. Methodenaufrufe.

Die einzelnen SOAP-API-Funktionen müssen nach dem Freischalten des Webservice-Zugangs nochmals einzeln pro Benutzer berechtigt werden. Dies funktioniert über die [ Detail ]-Schaltfläche in der Spalte "SOAP API". Alle dort verfügbaren Methoden lassen sich jeweils einzeln per Checkbox selektieren. Alternativ lässt sich dort auch eine Mehrfachauswahl per [ Alle ]-Schaltfläche durchführen, welche über die nebenstehende [ Keine ]-Schaltfläche wieder rückgängig gemacht werden kann. Sobald in diesem Dialogfenster mindestens eine Methode ausgewählt wurde, wird dies im Übersichtsdialog anhand einer Kreuz-Markierung in der "Soap API"-Spalte kenntlich gemacht.

Ein Benutzer benötigt zu Authentifizierungszwecken für jeden Funktionsaufruf zudem eine gültige Client-ID, die beim Login erzeugt wird. Die entsprechenden Login-Daten mit Anmeldenamen und Passwort lassen sich wiederum über den Button [ Service-User hinzufügen ] vergeben.

Mit der Dropdown-Liste "Zugriffstyp" haben Sie außerdem Auswahlmöglichkeiten hinsichtlich der passenden Benutzerlizenz. So können Sie hier beispielsweise eine Geschäftsobjekte-Lizenz je Nutzer selektieren. Generell gelten hierfür die Lizenzbedingungen laut Preisliste in Bezug auf Anforderungen und gleichzeitige Zugriffe.

Im Anschluss an die Freischaltung des Webservice-Zuganges können Sie für Ihr jeweiliges Anwendungsszenario und Ihre jeweils benötigten SOAP-Methoden eigene benutzerdefinierte Konfigurationseinstellungen für die SOAP-API vornehmen.

Vorlageadresse

Möchten Sie anhand einer externen Anwendung Adressen über die SOAP-API in die myfactory übertragen, so können Sie hier eine gewünschte Vorlageadresse für die importierten Adressdatensätze hinterlegen, um ein schnelleres Adresshandling zu ermöglichen.

Alle Artikel übermitteln

Mit dieser Option können Sie steuern, ob bei der Übertragung von Artikellisten über den SOAP-Webservice alle Artikel oder nur die Webshop-Artikel übermittelt werden sollen.

Inaktive Artikel nicht übermitteln

Mit dieser Option wird gesteuert, ob bei der Übermittlung von Artikellisten auch darin enthaltene inaktive Artikel übertragen werden sollen oder nicht.

Artikelverfügbarkeit nur über Verkaufsbelege

Ist diese Option gesetzt, dann wird die Artikelverfügbarkeit in der myfactory für eine per SOAP-API angebundene Drittanwendung dergestalt berechnet, dass vom vorhandenen Lagerbestand ausschließlich die bereits in Verkaufsbelegen enthaltenen Artikelmengen abgezogen und entsprechend bei der Verfügbarkeit berücksichtigt werden. Ist diese Option nicht gesetzt, dann fließen zusätzlich noch die geplanten Einkäufe in die allgemeine Artikelverfügbarkeit mit ein.

Standardbelegart für Verkaufs-Beleganlage

Die hier einzutragende Standardbelegart wird bei der Anlage eines Verkaufsbelegs immer dann herangezogen, wenn sonst keine spezifische Belegart angegeben wurde.

Standardbetriebsstätte für Verkaufs-Beleganlage

Diese standardmäßige Betriebsstätte wird bei der Beleganlage immer dann verwendet, wenn keine Betriebsstätte angegeben wurde.

Belegtexte bei Sprachenänderung aktualisieren

Ist diese Checkbox aktiviert, dann werden die per SOAP-API übermittelten Belegtexte (z.B. Langtexte im Beleg) bei einem angemeldeten fremdsprachigen Benutzer automatisch in dessen Zielsprache übersetzt.

Belegtexte bei Änderung des Ansprechpartners aktualisieren

Mit dieser Option kann gesteuert werden, ob bei der Änderung des Ansprechpartners im Verkaufsbeleg die Kopf-/Fußtexte aktualisiert werden sollen oder nicht.

Mehrere Varianten pro Belegposition

Mit dieser Option wird in der Verkaufsbelegposition anstelle der Felder "VariantID" und "SerialNumbers" das Array 'OrderPositionVariants' verwendet, welches mehrere Varianten pro Belegposition erlaubt - und zwar sowohl lesend als schreibend.

Belegmailversand aktivieren

Wenn SOAP-Methoden zum Senden von E-Mails verwendet werden sollen, dann können Sie hierüber spezifizieren, dass per SOAP-API auch Belegmails übermittelt werden dürfen.

Vorlage für Belegmail

Sofern Sie die Checkbox zum Belegmailversand per SOAP-API gesetzt haben, können Sie in diesem Feld noch eine Mail-Vorlage für über die Schnittstelle zu übermittelnde Belegmails hinterlegen.

Standardbelegart für Einkaufs-Beleganlage

Die hier hinterlegte Standardbelegart wird für das Anlegen von Einkaufsbelegen herangezogen, wenn für diese keine spezifische Belegart angegeben wurde.

Standardbetriebsstätte für Einkaufs-Beleganlage

Diese Betriebsstätte wird für die Beleganlage verwendet, wenn zuvor keine andere Betriebsstätte angegeben wurde.

Nur durch API angelegte Stücklistenpositionen löschen

Da bei den SOAP-API-Berechtigungen standardmäßig auch eine Methode für das Schreiben von Stücklistenpositionen in die myfactory auswählbar ist, kann mit dieser Option festgelegt werden, dass nur solche über die Schnittstelle erstellten Positionen innerhalb einer Stückliste entfernt werden dürfen. Alle nativ in der myfactory-Anwendung angelegten Stücklistenpositionen bleiben davon dann unberührt.

Betriebsstätte für Reservierungen

Hinterlegen Sie hier eine beliebige Betriebsstätte, die für die Verwaltung der myfactory-Reservierungsfunktionalität über eine externe Anwendung herangezogen werden kann. Hierzu stehen Ihnen SOAP-Methoden zum Setzen oder Löschen einer Artikelreservierung zur Verfügung.

Webshop-Dokumente als Binärdaten übergeben

Wenn Sie diese Checkbox setzen, dann wird ein via SOAP-Schnittstelle übertragenes Webshop-Dokument, welches Sie beispielsweise in Form eines Artikelbildes in einen angebundenen externen Shop übertragen möchten, nicht nur als Link, sondern zusätzlich direkt als physische Binärdatei an das externe Tool übergeben. Bitte beachten Sie hierbei jedoch, dass der für den Funktionsaufruf benötigte Quellcode dadurch deutlich länger wird.

Ist diese Option nicht gesetzt, dann wird lediglich die URL des Webshop-Dokumentes über die Schnittstelle übermittelt.

Hinweis:

Da dies ein entwicklerspezifisches Themengebiet ist, wenden Sie sich für weitere Informationen bitte an den Sie betreuenden Entwicklungspartner. Die Partner selbst können wiederum auf das Handbuch "Dokumentation universelle SOAP-Schnittstelle" zurückgreifen. Dieses findet sich im Entwicklungsbereich des Partnerportals ("Dev / Source Code")