Dieser Artikel wurde mit Unterstützung von KI-Tools bei der Recherche und Texterstellung erstellt. Vor der Veröffentlichung wurde er von unserem Redaktionsteam redaktionell und inhaltlich geprüft und einem Faktencheck unterzogen.

Liefert Informationen zur Einrichtung aller Schnittstellen und Integrationen, die in Aptean Equipment DMS verwendet werden.

Schnittstellen und Integrationen

Hinweis

Die Schnittstellen und Integrationen werden laufend weiterentwickelt. Die vorliegende Dokumentation beschreibt ggf. nicht die neuesten Funktionen bzw. ist ggf. unvollständig, da die Entwicklung noch nicht abgeschlossen ist. Die neuesten Informationen finden Sie in den Release Notes (bis März 2026) oder unter Neue & geplante Funktionen.

In unserer ERP-Lösung funktioniert die Einrichtung von Schnittstellen weitgehend automatisch. Beim Öffnen der Seite Schnittstellenliste über die Schnellsuche (ALT+Q) werden die Basiswerte Schnittstellenart, Beschreibung, Anbietercode, Gruppencode und alle möglichen Parameter einschließlich aller ihrer Abhängigkeiten automatisch initialisiert (mit Ausnahme der händlerspezifischen Parameter). Dies gilt für alle neuen Mandanten.

Dieses Kapitel ist in die folgenden Abschnitte gegliedert:

Inforegister 'Allgemein'

Das Inforegister Allgemein enthält die grundlegenden Informationen zur Schnittstelle. Die Werte werden automatisch eingerichtet. Die schreibgeschützten Felder Anbietercode und Gruppencode werden zur Definition eines bestimmten Herstellers oder Partners sowie eines Bereichs (z. B. Trade, Service) verwendet, um die Liste für eine bessere Übersicht filtern zu können. Die Werte im Feld Anbietercode werden der Tabelle Schnittstellenanbieter entnommen, die bei der Initialisierung der Schnittstelle automatisch befüllt wird.

Schnittstellenprotokoll

Der Schieberegler Schnittstellenprotokoll kann vom Händler manuell aktiviert werden, um alle Schnittstellenaktivitäten zu protokollieren und über die Schaltfläche Protokoll in der Menüleiste auf weitere Prozess- oder Import-/Exportdatei-Informationen zuzugreifen. Entsprechende Anweisungen sind in der jeweiligen Schnittstellendokumentation beschrieben.

Tipp

Verwenden Sie bei aktiviertem Schieberegler Schnittstellenprotokoll zusätzlich den Wert Protokolleinträge löschen nach, um alte Schnittstellenaktivitäten regelmäßig zu löschen.
Verwenden Sie diese Option mit Bedacht und unter Beachtung Ihrer Aufbewahrungspflichten!

Ausführungsmodi

VORSICHT!

Alle aktuellen Einstellungen der Schnittstelle werden beim Moduswechsel überschrieben! Sie können nicht wiederhergestellt werden.

Über die Schaltfläche Ausführungsmodus wechseln werden die Schnittstelle und alle ihre Einstellungen zwischen den verschiedenen Test- und Produktivumgebungen, falls verfügbar, umgeschaltet. Nach dem Klicken auf diese Schaltfläche können Benutzer auswählen, welcher Modus angewendet werden soll. Nach dem Auswählen eines anderen Modus werden die Standardparameter dieses Modus übernommen. Standardmäßig werden die Schnittstellen als Produktiv initialisiert. Folgende Modi stehen zur Verfügung:

Modus Beschreibung
leer Wird nur angezeigt, wenn keine Modusauswahl verfügbar ist.
Test Richtet die Testumgebung mit Standardparametern ein, sofern verfügbar.
Produktiv Richtet die Produktivumgebung mit Standardparametern ein.
Individuell Wird nur angezeigt, wenn kein gültiger Test- oder Produktivmodus definiert ist.

Inforegister 'Autorisierung'

Im Inforegister Autorisierung definieren Sie die Autorisierungsoptionen, die die Schnittstelle oder Integration zur Authentifizierung gegenüber dem Dienst außerhalb unserer ERP-Lösung benötigt. Die Felder im Inforegister Autorisierung werden abhängig von der ausgewählten Autorisierungsart angezeigt:

Autorisierungsart Angezeigte Felder
leer Es werden keine weiteren Felder angezeigt.
API-Schlüssel Nur das Feld Autorisierungscode wird angezeigt.
Basis Nur das Feld Autorisierungscode wird angezeigt.
JWT (JSON Web Token) Nur das Feld Autorisierungscode wird angezeigt.
OAuth2 Die Felder Autorisierungscode und Bereich werden angezeigt.
Das Feld Bereich dient der Definition der schnittstellenspezifischen Zugriffsparameter. Diese werden bei der Initialisierung automatisch eingerichtet.

Bei allen Autorisierungstypen (mit Ausnahme von leer) verweist das Feld Autorisierungscode auf einen speziellen Anwendungsendpunkt, der die tatsächlichen Anmeldedaten für die ausgewählte Authentifizierungsmethode enthält. Details zur Konfiguration finden Sie unter Autorisierungsendpunkt-Einrichtung.

Inforegister 'Parameter'

Parameter werden verwendet, um bestimmte Optionen für die Verwendung der Schnittstelle einzurichten. Dazu gehören z. B. spezifische Definitionen für Import- oder Exportdateien, händlerspezifische Konten oder Ressourcen, URLs, Währungs- oder Sprachcodes, Standardwerte usw. Das Feld Anweisungen enthält entsprechende Hinweise zum Ausfüllen des Felds Wert.

Viele Felder Wert im Inforegister Parameter unterstützen die Suchfunktion, sodass gültige Werte direkt ausgewählt werden können. Andere Felder erfordern einfachen Text oder Zahlen gemäß der entsprechenden Schnittstellendokumentation oder der über das Symbol i in der oberen rechten Ecke aufrufbaren Infobox Anweisungen. Beim Ändern der Benutzersprache werden sowohl die Anweisungen als auch die Parameterwerte automatisch lokalisiert, sofern die entsprechenden Übersetzungen in unserer ERP-Lösung verfügbar sind.

Tipp

Im Feld Wert aktivieren Sie Funktionen mit 1 oder ja und deaktivieren sie mit 0 oder nein.

Das Kontrollkästchen Gesicherter Wert dient zum Einrichten von Parametern, deren tatsächlicher Wert für Benutzer nicht lesbar sein darf. Bei aktiviertem Kontrollkästchen wird der eingegebene Wert durch Punkte (•) ersetzt, sodass er nicht eingesehen oder zurückentwickelt werden kann.

Wichtig

Die Aktivierung des Kontrollkästchens wird bei der Initialisierung der Parameter festgelegt und kann im laufenden Betrieb nicht geändert werden.

Ein Debugging ist bei diesen Parametern nicht möglich, da kein Zugriff von außen möglich ist.

Die Farbcodierung im Inforegister Parameter hat die folgende Bedeutung:

Schriftfarbe Bedeutung
Rot Händlerspezifischer Pflichtparameter hat noch keinen Wert; Schnittstelle ist nicht voll funktionsfähig.
Grün Händlerspezifischer Pflichtparameter hat einen Wert.
Schwarz Optional Ein Wert ist nur für Komfortfunktionen erforderlich. Wenn Sie einen Wert eingeben, können Sie die unter Anweisungen beschriebene Funktion verwenden.

Nach einer neuen Version sind möglicherweise neue Parameter und Einstellungen erforderlich. Über die Schaltfläche Parameter und Einrichtungen aktualisieren in der Menüleiste werden fehlende Parameter und Einstellungen hinzugefügt und obsolete Parameter und Einstellungen auf Grundlage der aktuellen Schnittstellendefinition entfernt. Bestehende Werte werden nicht geändert.

Hinweis

Wenn ein neuer notwendiger Parameter keinen Wert aufweist und die Schnittstelle aktiv ist, wird diese automatisch deaktiviert.

Inforegister 'Zuordnungseinrichtung'/'Einrichtung'

Hinweis

Das Inforegister Zuordnungseinrichtung/Einrichtung ist nur bei Schnittstellen oder Integrationen verfügbar, wenn es benötigt wird.

Die Zuordnungseinrichtung zeigt verschiedene Objekte, die vor der Datenverarbeitung durch die Schnittstelle mit Werten gefüllt werden müssen. Normalerweise gilt dies nur für händlerspezifische Objekte wie Ressourcen, Artikel usw. Für Werte im Inforegister Parameter ist in den meisten Fällen eine vollständige Zuordnungseinrichtung erforderlich, um die Suchfunktion über das Auswahlfeld nutzen zu können. Um ein Objekt mit den erforderlichen Daten zu befüllen, gehen Sie wie folgt vor:

Hinweis

Je nach Umfang der hinzuzufügenden Daten kann der folgende Vorgang einige Zeit in Anspruch nehmen!

  • Klicken Sie auf den Objektnamen in der Spalte Name, um die entsprechende Tabelle zu öffnen.
  • Fügen Sie neue Zeilen für alle erforderlichen Werte hinzu.
  • Befüllen Sie die neuen Zeilen.
  • Schließen Sie die Tabelle.
  • Bestätigen Sie das Dialogfenster Möchten Sie die Einrichtung der Schnittstelle für [...] abschließen? mit Ja.
    • Wenn Sie auf Ja klicken, wird das Kontrollkästchen Abgeschlossen automatisch aktiviert, und der Wert Name wechselt von roter in grüne Schrift.
    • Wenn Sie auf Nein klicken, bleibt der Wert Name in roter Schrift, und das Kontrollkästchen Abgeschlossen bleibt deaktiviert. Sie können die Einrichtung später erneut starten, aber die Schnittstelle kann erst aktiviert werden, wenn die Zuordnungs- und Parametereinrichtungen abgeschlossen sind.
  • Wiederholen Sie diese Schritte für alle Objekte, bei denen das Kontrollkästchen Notwendig aktiviert ist. Andernfalls kann die Schnittstelle oder Integration nicht aktiviert werden!

Tipp

Objekte, bei denen das Kontrollkästchen Notwendig deaktiviert ist, sind optional.

Nach einer neuen Version sind möglicherweise neue Parameter und Einstellungen erforderlich. Über die Schaltfläche Parameter und Einrichtungen aktualisieren in der Menüleiste werden fehlende Parameter und Einstellungen hinzugefügt und obsolete Parameter und Einstellungen auf Grundlage der aktuellen Schnittstellendefinition entfernt. Bestehende Werte werden nicht geändert.

Hinweis

Wenn ein neuer notwendiger Parameter keinen Wert aufweist und die Schnittstelle aktiv ist, wird diese automatisch deaktiviert.

Schnittstellen aktivieren

Wenn alle Anforderungen erfüllt sind (nur grüne und/oder schwarze Werte im Inforegister Parameter und/oder nur grüne Werte im Inforegister Zuordnungseinrichtung), gehen Sie wie folgt vor:

  • Klicken Sie in der Menüleiste auf Schnittstelle aktivieren. Der Schieberegler Allgemein > Aktiv ist aktiviert.

Hinweis

Wenn eine Schnittstelle oder Integration auf einer Aufgabenwarteschlange basiert, wird diese nach erfolgreicher Aktivierung automatisch zur Seite Aufgabenwarteschlangenposten hinzugefügt und wie in der entsprechenden Schnittstellendokumentation beschrieben eingerichtet. In diesem Fall wird ein entsprechender Schnellhinweis unter der Menüleiste angezeigt.

Wenn eine Voraussetzung fehlt, wird ein Dialogfenster mit einer Übersicht über alle notwendigen Parameter oder Zuordnungseinrichtungen angezeigt, die noch keinen Wert haben.

Wenn Sie die erforderlichen Werte hinzufügen und durch Klicken auf die Schaltfläche OK bestätigen, ist die Schnittstelle aktiviert und funktionsfähig. Wenn Sie die erforderlichen Werte nicht hinzufügen und dies durch Klicken auf die Schaltfläche OK bestätigen, kann die Schnittstelle nicht aktiviert werden.

Tipp

Falls eine Schnittstelle oder Integration nicht mehr wie vorgesehen funktioniert oder es ein Problem mit einem bestimmten Parameter gibt, können Sie die Schaltfläche Wiederherstellen oder Wiederherstellen > Autorisierung wiederherstellen / Parameter wiederherstellen / Einrichtung wiederherstellen im entsprechenden Inforegister verwenden. Damit werden alle Werte auf die bei der Initialisierung der Schnittstelle eingegebenen Standardwerte zurückgesetzt.

Schnittstellen deaktivieren

Um eine aktive Schnittstelle zu deaktivieren, gehen Sie wie folgt vor:

  • Klicken Sie in der Menüleiste des Inforegisters Allgemein auf Schnittstelle deaktivieren. Der Schieberegler Allgemein > Aktiv ist deaktiviert.

Alle bestehenden Protokolleinträge und Konfigurationen bleiben erhalten.

Autorisierungsendpunkt-Einrichtung

Für jede Autorisierungsart (außer leer) muss ein eigener Anwendungsendpunkt konfiguriert werden. Der Endpunkt enthält die Anmeldedaten und Einstellungen, die zur Authentifizierung beim externen Service verwendet werden. Endpunkte werden zentral verwaltet und können über das Feld Autorisierungscode im Inforegister Autorisierung über mehrere Schnittstellen hinweg referenziert werden.

Wichtig

Alle Anmeldedaten werden sicher gespeichert, sodass sie im Falle eines Passwortverlusts weder wiederhergestellt noch rekonstruiert noch aus dem Code ausgelesen werden können. Bitte bewahren Sie alle Zugangsdaten zusätzlich an einem anderen Ort sicher auf, für den Fall, dass Passwörter zurückgesetzt werden müssen.
Für Umgebungen ohne Passwörter (einige lokale oder Entwicklungssysteme) ändert sich nichts.

Dieser Abschnitt ist in die folgenden Unterabschnitte gegliedert:

Basis-Anwendungsendpunkt

Der Anwendungsendpunkt Basis speichert die Anmeldedaten für die HTTP-Basis-Authentifizierung. Öffnen Sie die Seite Basis-Anwendungsendpunkte über die Schnellsuche (ALT+Q), um Endpunkte zu erstellen und zu verwalten. Die folgenden Felder sind verfügbar, wenn Sie auf der Seite Basis-Anwendungsendpunkt-Karte einen neuen Eintrag erstellen oder einen bestehenden bearbeiten:

Feld Beschreibung
Basis-Endpunktcode Geben Sie den eindeutigen Bezeichner für den Endpunkt ein. Dieser Wert wird im Feld Autorisierungscode der Schnittstellenkarte angegeben.
Beschreibung Geben Sie einen aussagekräftigen Namen für den Endpunkt ein.
Benutzername Geben Sie den Benutzernamen ein, der beim Aufrufen des externen Diensts für die HTTP-Basis-Authentifizierung verwendet wird.
Kennwort Geben Sie das Kennwort für die HTTP-Basis-Authentifizierung ein. Dieser Wert wird sicher gespeichert und als Punkte angezeigt.
URL Geben Sie die Basis-URL des externen Diensts ein, mit dem dieser Endpunkt eine Verbindung herstellt.

OAuth2-Anwendungsendpunkt

Der Anwendungsendpunkt OAuth2 speichert die Anmeldedaten für die OAuth2-Authentifizierung. Öffnen Sie die Seite OAuth2-Anwendungsendpunkte über die Schnellsuche (ALT+Q), um Endpunkte zu erstellen und zu verwalten. Die folgenden Felder sind verfügbar, wenn Sie auf der Seite OAuth2-Anwendungsendpunkt-Karte einen neuen Eintrag erstellen oder einen bestehenden bearbeiten:

Feld Beschreibung
OAuth-Endpunktcode Geben Sie den eindeutigen Bezeichner für den Endpunkt ein. Dieser Wert wird im Feld Autorisierungscode der Schnittstellenkarte angegeben.
Beschreibung Geben Sie einen aussagekräftigen Namen für den Endpunkt ein.
Client-ID Geben Sie die beim externen OAuth2-Anbieter registrierte Anwendungs-ID (Client-ID) ein.
Geheimer Clientschlüssel Geben Sie den vom OAuth2-Anbieter ausgegebenen geheimen Clientschlüssel ein. Dieser Wert wird sicher gespeichert.
Authentifizierungsendpunkt-URL nur verfügbar, wenn OAuth2-Autorisierungsmethode = Authentifizierungscode Geben Sie die URL ein, um einen Autorisierungscode gegen ein Zugriffstoken zu tauschen.
Token-Endpunkt-URL Geben Sie die URL ein, über die ein Zugriffstoken beim OAuth2-Anbieter angefordert werden soll.
OAuth2-Autorisierungsmethode Wählen Sie den OAuth2-Gewährungstyp aus:
• Authentifizierungscode: Geben Sie die Authentifizierungsendpunkt-URL ein, um den Anbieter anzugeben, von dem der Code abgerufen wird.
• Client-Anmeldedaten: Sie werden zur Eingabe Ihrer Client-Anmeldedaten aufgefordert, wenn Microsoft Dynamics Business Central zum ersten Mal versucht, auf die mit diesem Autorisierungsendpunkt verknüpfte Schnittstelle zuzugreifen.
Client-Authentifizierungsmethode Legen Sie fest, wie die Client-Anmeldedaten an den Token-Endpunkt übermittelt werden sollen:
• Als Basis-Authent.-Header senden: Die Client-Anmeldedaten werden im Header der HTTP-Anfrage übermittelt.
• Client-Anmeldedaten im Body senden: Die Client-Anmeldedaten werden im Body der HTTP-Anfrage übermittelt.

Um sich im Namen einzelner Benutzer zu authentifizieren, weisen Sie über Benutzer-Zugriffstoken in der Menüleiste pro Benutzer ein OAuth2-Token zu.

JWT-Anwendungsendpunkt

Der Anwendungsendpunkt JWT speichert die Konfiguration für die JSON-Web-Token-Authentifizierung (JWT). Öffnen Sie die Seite JWT-Anwendungsendpunkte über die Schnellsuche (ALT+Q), um Endpunkte zu erstellen und zu verwalten.

Die folgenden Felder sind verfügbar, wenn Sie auf der Seite JWT-Anwendungsendpunkt-Karte einen neuen Eintrag erstellen oder einen bestehenden bearbeiten (Inforegister Allgemein):

Feld Beschreibung
JWT-Endpunktcode Geben Sie den eindeutigen Bezeichner für den Endpunkt ein. Dieser Wert wird im Feld Autorisierungscode der Schnittstellenkarte angegeben.
Beschreibung Geben Sie einen aussagekräftigen Namen für den Endpunkt ein.
Signaturalgorithmus Wählen Sie den Algorithmus aus, der zum Signieren des JWT verwendet werden soll. Durch eine Änderung des Algorithmus werden alle zuvor gespeicherten Signaturschlüssel gelöscht.
Verfügbare Optionen:
• HS256 (HMAC-SHA256): signiert das JWT mit einem gemeinsamen Geheimschlüssel
• RS256 (RSA-SHA256): signiert das JWT mit einem RSA-Privatschlüssel
nbf-Claim einbeziehen Aktivieren Sie diesen Schieberegler, um den Claim not-before (nbf, nicht vor) mit dem aktuellen Zeitstempel als Wert in die JWT-Nutzdaten aufzunehmen.

Informationen zur Einrichtung der anderen Inforegister finden Sie nachfolgend:

JWT-Signatur

Wenn Signaturalgorithmus = HS256 (HMAC-SHA256), wird das Inforegister HS256-Signaturschlüssel angezeigt. Geben Sie den gemeinsamen geheimen Schlüssel in das Feld Geheimer Signaturschlüssel (HS256) ein. Dieser Wert wird sicher gespeichert.

Wenn Signaturalgorithmus = RS256 (RSA-SHA256), wird das Inforegister RS256-Privatschlüssel angezeigt. Der schreibgeschützte Schieberegler Privatschlüssel vorhanden zeigt an, ob bereits ein privater Schlüssel importiert wurde. Wenn ja, ist er aktiviert.

Um einen RSA-Privatschlüssel zu importieren, gehen Sie wie folgt vor:

Wichtig

Privatschlüssel werden in einem isolierten Speicher abgelegt und beim Kopieren oder Wiederherstellen einer Umgebung nicht übertragen. Importieren Sie den Privatschlüssel nach jeder Umgebungsmigration erneut.

  • Klicken Sie in der Menüleiste auf Privatschlüssel importieren (Datei), um den Schlüssel aus einer PEM-Datei zu importieren.
    oder
    Fügen Sie den Schlüssel direkt ein:
    • Wählen Sie im Feld Schlüsselformat das Format PEM oder XML (RSAKeyValue) aus.
    • Fügen Sie den Schlüsseltext in das Feld Privatschlüssel ein.
    • Klicken Sie in der Menüleiste auf Schlüssel anwenden.

Tipp

Um einen vorhandenen Privatschlüssel zu entfernen, klicken Sie in der Menüleiste auf Privatschlüssel löschen.

Standard-Claims

Im Inforegister Standard-Claims werden die integrierten JWT-Nutzdaten-Claims definiert:

Feld Claim Beschreibung
Aussteller iss Geben Sie den Aussteller-Claim des JWT (JSON Web Token) ein.
Subjekt sub Optional Geben Sie den Subjekt-Claim ein, der den Prinzipal identifiziert.
Zieldomäne aud Optional Geben Sie den Zieldomänen-Claim ein, der die vorgesehenen Empfänger identifiziert.
Token-Ablauf (Sek.) exp Geben Sie die Dauer in Sekunden ein, bis das JSON Web Token abläuft.
Mindestwert: 1.
Standardwert: 3600

Zusätzliche benutzerdefinierte Claims können im Inforegister Benutzerdefinierte Claims am unteren Rand der Seite JWT-Anwendungsendpunkt-Karte definiert werden, indem die entsprechenden Werte für Claim-Name und Claim-Wert in die Tabelle eingegeben werden.

Hinweis

Die reservierten Namen iss, sub, aud, exp, iat, nbf und jti dürfen nicht als benutzerdefinierte Claim-Namen verwendet werden.

Token-Austausch

Standardmäßig wird das signierte JSON Web Token direkt als Bearer-Token verwendet. Bei aktiviertem Schieberegler Token-Austausch verwenden im Inforegister Token-Austausch wird das signierte JSON Web Token stattdessen an einen externen Token-Endpunkt übermittelt, um im Gegenzug ein separates Zugriffstoken zu erhalten. Die folgenden zusätzlichen Felder sind verfügbar, wenn der Schieberegler Token-Austausch verwenden aktiviert ist:

Feld Beschreibung
Token-Endpunkt-URL Geben Sie die URL ein, die das signierte JSON Web Token per HTTP-POST empfängt und im Gegenzug ein Zugriffstoken zurückgibt.
JSON-Antwortschlüssel Geben Sie den Feldnamen in der JSON-Antwort des Token-Endpunkts an, der das Zugriffstoken enthält.
Standardwert: access_token
Einwilligungsautorisierungs-URL Optional Geben Sie die Autorisierungs-URL ein, über die die Einwilligung des Benutzers eingeholt wird (z. B. für DocuSign). Lassen Sie das Feld leer, wenn kein Einwilligungsprozess erforderlich ist.
Einwilligungs-Client-ID Optional Geben Sie den Integrationsschlüssel oder die Client-ID ein, die beim Einwilligungsprozess verwendet wird. Lassen Sie das Feld leer, um den Wert Aussteller zu verwenden.
Einwilligungsbereich Optional Geben Sie die durch Leerzeichen getrennte Liste der Bereiche ein, für die Sie eine Einwilligung beantragen möchten (z. B. signature impersonation).
Einwilligung zuletzt erteilt am Referenz Zeitstempel der letzten erfolgreichen Einwilligung.
Token gültig bis Referenz Zeitstempel für das Ablaufdatum des derzeit zwischengespeicherten Zugriffstokens.

Falls ein Einwilligungsprozess erforderlich ist, gehen Sie wie folgt vor:

  • Füllen Sie die Felder Einwilligungsautorisierungs-URL, Einwilligungs-Client-ID und Einwilligungsbereich im Inforegister Token-Austausch aus.
  • Klicken Sie in der Menüleiste auf Weiterleitungs-URI anzeigen.
  • Registrieren Sie die angezeigte URI beim Integrationsschlüssel im Anbieterportal.
  • Klicken Sie in der Menüleiste auf Einwilligung anfordern, um das Dialogfenster zur Einwilligungserteilung zu öffnen.
  • Gewähren Sie im Dialogfenster den Zugriff.

Über den Token-Austausch abgerufene Zugriffstoken werden automatisch zwischengespeichert und bei Ablauf aktualisiert.

API-Schlüssel-Anwendungsendpunkt

Der Anwendungsendpunkt API-Schlüssel speichert die Konfiguration für die API-Schlüssel-basierte Authentifizierung. Öffnen Sie die Seite API-Schlüssel-Anwendungsendpunkte über die Schnellsuche (ALT+Q), um Endpunkte zu erstellen und zu verwalten.

Der Endpunkt ruft ein Bearer-Token von einer externen URL ab, wobei der konfigurierte API-Schlüssel als Anmeldedaten für die Basis-Authentifizierung verwendet wird. Das Token wird automatisch zwischengespeichert und nach Ablauf aktualisiert.

Die folgenden Felder sind verfügbar, wenn Sie auf der Seite API-Schlüssel-Endpunktkarte einen neuen Eintrag erstellen oder einen bestehenden bearbeiten:

Feld Beschreibung
API-Schlüssel-Endpunktcode Geben Sie den eindeutigen Bezeichner für den Endpunkt ein. Dieser Wert wird im Feld Autorisierungscode der Schnittstellenkarte angegeben.
Beschreibung Geben Sie einen aussagekräftigen Namen für den Endpunkt ein.
Token-Abruf-URL Geben Sie die HTTP-Endpunkt-URL ein, die beim Aufrufen mit dem API-Schlüssel als Anmeldedaten für die Basis-Authentifizierung ein Bearer-Token zurückgibt.
API-Schlüssel Geben Sie den API-Schlüssel ein, der beim Aufrufen der Token-Abruf-URL als Anmeldedaten für die Basis-Authentifizierung verwendet wird. Dieser Wert wird sicher gespeichert.
JSON-Antwortschlüssel Geben Sie den Feldnamen in der JSON-Antwort an, der das Token enthält.
Standardwert: access_token

Um zwischengespeicherte Token und deren Ablaufdaten anzuzeigen, klicken Sie in der Menüleiste auf Navigation > Tokens.

Einrichtung Schnittstellenstapel

Auf der Seite Einrichtung Schnittstellenstapel können Administratoren die Stapel konfigurieren, die im Schnittstellen-Rollencenter angezeigt werden. Jeder Stapel zeigt die Anzahl von Schnittstellen-Protokolleinträgen an, optional gefiltert nach Schnittstellenart, Protokolleintragsstatus und danach, ob die Einträge bereits bearbeitet wurden.

Öffnen Sie die Seite Einrichtung Schnittstellenstapel über die Schnellsuche (ALT+Q), um die Konfiguration zu verwalten. Folgende Spalten sind verfügbar:

Spalte Beschreibung
Stapel Wählen Sie den Stapelbereich im Schnittstellen-Rollencenter aus, den diese Zeile konfiguriert.
Beschreibung Geben Sie die Beschriftung ein, die für den Stapel im Schnittstellen-Rollencenter angezeigt werden soll.
Stapelname Referenz Gibt den Systemnamen des Stapel-Steuerelements an, mit dem diese Zeile verknüpft ist.
Stapel anzeigen Wenn das Kontrollkästchen aktiviert ist, wird der Stapel im Schnittstellen-Rollencenter angezeigt. Deaktivieren Sie das Kontrollkästchen, um ihn auszublenden.
Schnittstellenart-Filter Beschränkt die Zählung auf Protokolleinträge einer bestimmten Schnittstellenart. Lassen Sie das Feld leer, um alle Schnittstellenarten einzubeziehen.
Statusfilter Gibt an, ob für diesen Stapel ein Statusfilter aktiv ist. Auf der Seite Statusfilter-Stapeleinrichtung können Sie festlegen, welche Protokolleintragsstatus berücksichtigt werden sollen.
Bearbeiteter Filter Gibt an, ob beim Stapel nur nicht bearbeitete Einträge (Nein), nur bearbeitete Einträge (Ja) oder alle Einträge (Nicht gefiltert) gezählt werden.

Liste unterstützter Schnittstellen

Nachstehend finden Sie eine Liste aller Schnittstellen und Integrationen, die derzeit von unserer ERP-Lösung unterstützt werden: