myfactory Online-Hilfe

Inhalt

myfactory.API-Verbindungen


Anhand dieses Dialogs lässt sich eine REST-API-Verbindung (REST = "Representational State Transfer") mit Zugangsdaten anlegen und konfigurieren. Diese erlaubt es Ihnen, aus einer externen Anwendung heraus mit der myfactory zu kommunizieren. Dies dient primär dazu, Daten aus der myfactory auszulesen und sie in der externen Anwendung, z.B. einem Auswertungs-Tool wie Microsoft PowerBI, zu verwenden. Ein entsprechendes Praxisbeispiel anhand von PowerBI entnehmen Sie bitte dem zugehörigen HowTo-Kapitel (myfactory als Datenquelle: Die REST API für die Microsoft PowerBI-Auswertung nutzen).

Register "Grundlagen"


Die eigentlichen API-Verbindungen können Sie unter Angabe eines Usernamens und eines Passworts in diesem "Grundlagen"-Register anlegen.

myfactory.API-Verbindungen 0
Bezeichnung

Geben Sie hier bitte eine sinnvolle Bezeichnung für die API-Verbindung ein.

Checkbox "Inaktiv"

Ist diese Option gesetzt, so wird die mit diesem Flag gekennzeichnete API-Verbindung in der Übersichtsliste standardmäßig ausgeblendet. Möchten Sie das Setzen des "Inaktiv"-Flags rückgängig machen, so müssen Sie zuerst den Inaktiv-Datensatzfilter aktivieren, damit die API-Verbindung in der Liste wieder auftaucht. Anschließend können Sie den entsprechenden Haken entfernen.

Eigentümer

Mit dem Festlegen eines Eigentümers haben Sie eine Filtermöglichkeit zur Hand, um den Datenzugriff pro API-Verbindung und Benutzer über Datensatzberechtigungen einzuschränken. Beispielsweise können Sie über das Setzen einer entsprechenden Zugriffsberechtigung auf dem Benutzer verhindern, dass Projektleiter über die API-Verbindung untereinander Einsicht in die jeweils mit einem Projekt erzielten Umsätze erhalten. Ebenso könnten Sie pro Vertreter eine eigene API-Verbindung mit jeweils unterschiedlichem Eigentümer definieren, um zu vermeiden, dass die Vertreter über die REST API untereinander ihre Kontakteinträge (z.B. die Anzahl der Besuche pro Kontakt) zu sehen bekommen.

Grundsätzlich sollte also jeder API-Verbindung aus Datenschutzgründen ein eigener Eigentümer mit individuellen Datensatzberechtigungen zugeordnet sein, damit kein Benutzer darüber mehr Berechtigungen erhält als über die myfactory selbst.
Diese Art der Datenfilterung stellt eine weitere spezifische Filtermöglichkeit dar, die auf Datensatzebene arbeitet. Über das Register "Datenkonfiguration" können Sie für jede API-Verbindung noch zusätzlich Einschränkungen auf Datentypebene vornehmen (siehe unten).

Loginname / Passwort

Vergeben Sie hier bitte einen beliebigen Benutzernamen sowie ein beliebiges Kennwort. Sie benötigen beides, um sich in der externen Anwendung für die Verbindung mit der myfactory-Datenquelle zu authentifizieren. Das verschlüsselte Passwort wird nach Speichern der API-Verbindung automatisch aus dem Eingabefeld entfernt. Seine Gültigkeit für die Herstellung der API-Verbindung verliert es dadurch jedoch nicht.

Beschreibung

In dieses Textfeld können Sie eine griffige Beschreibung für die hier angelegte API-Verbindung eintragen.

URL für myfactory.API-Zugriff

Nachdem Sie die API-Verbindung mit den Zugangsdaten gespeichert haben, wird in dieser Zeile automatisch eine OData-REST-URL generiert. In einer externen Anwendung lässt sich mit dieser URL die REST API ansprechen, über welche die myfactory-Daten abgerufen und in die Anwendung importiert werden. Der Zugriff auf die REST-Schnittstelle erfolgt dabei über das OData-Protokoll (= OpenData-Protokoll), welches dem HTTP-basierten Datenaustausch zwischen zwei Softwaresystemen dient.

myfactory.API-Übersicht

Hier finden Sie eine weitere URL, die Sie auch anklicken können. Nach Aufruf dieses Links öffnet sich ein neues Fenster mit einer Beschreibung aller myfactory-Datensätze, die sich über die REST API in die externe Anwendung importieren lassen. Wenn Sie eine einzelne Beschreibung (oder optional alle) aufklappen, sehen Sie außerdem eine Auflistung der einzelnen Datenfelder, die für jeden Datensatz mit importiert werden. Für den Artikelstamm sind das beispielsweise die Felder "Artikelnummer", "Artikelstatus" und "Artikeltyp".

myfactory.API-Verbindungen 1

Register "Filter"


Tragen Sie in diesem Register keine Betriebsstätte ein, so werden die Daten sämtlicher Betriebsstätten geliefert. Geben Sie z.B. eine 1 ein, so werden nur die Daten der Betriebsstätte "Zentrale" zur Auswertung in einer externen Anwendung herangezogen. Die Daten aus der Betriebsstätte 2 können hingegen nicht verwertet werden.

myfactory.API-Verbindungen 2

Register "Datenkonfiguration"


Anhand der Einstellungen in diesem Register legen Sie fest, welche Arten von Datentypen ein Nutzer dieser API-Verbindung in der externen Anwendung sehen und auslesen darf. So lassen sich hierüber unter anderem Artikel- und Adressdaten, sowie Fibu- oder Produktionsdaten über die Schnittstelle bereitstellen. Zusätzliche Einstellungen können Sie in den auf die "Aktiv"-Checkbox folgenden Spalten vornehmen. Beispielsweise lässt sich der Zeitraum definieren, für den die Fibu-Daten aus der myfactory ausgelesen werden sollen. Dieses Register ist - neben der Eingrenzung über das "Eigentümer"-Auswahlfeld im Register "Grundlagen" - die zweite Möglichkeit der "API-Datenfilterung".

Bitte beachten Sie:

Wenn Sie trotz einer Auswahl an Datentypen keine Daten aus der myfactory in Ihr Auswertungs-Tool importieren können und den HTTP-Statuscode 404 (Seite nicht gefunden) erhalten, so starten Sie bitte den IIS auf Ihrem Server neu. Sollten Sie keinen Zugriff auf den IIS bzw. den Server haben, dann informieren Sie bitte Ihren jeweiligen Partner.


myfactory.API-Verbindungen 3

Register "Historie"


Wenn Sie das Änderungsprotokoll für die myfactory.API-Verbindungen aktiviert haben (siehe "Administration / Änderungsprotokoll / Konfiguration"), können Sie über dieses Register Ihre getätigten Änderungen nachvollziehen.

myfactory.API-Verbindungen 4

Weitere Informationen zu diesem Thema:

© myfactory International GmbH 2016. Alle Rechte vorbehalten.

Über uns

myfactory ist die webbasierte Business Software für KMU in den Bereichen ERP, CRM, PPS, MIS, Portal, Shop, Groupware und Finanzbuchhaltung.

Kontakt

Agnes-Pockels-Bogen 1
D-80992 München

06.09.2019
03.09.2019
30.08.2019
27.08.2019
23.08.2019