Anwendungen auf Basis der SelectLine API

SelectLine MDE, sowie SelectLine BDE basieren auf der SelectLine API. Für diese, sowie für selbst programmierte API Anwendungen sind folgende Informationen zur Dokumentation und zur Konfiguration von Standardwerten wichtig.

Dokumentation und Testumgebung

Mit der Einrichtung der SelectLine API wird auch eine zur installierten Version gehörende Hilfe bereitgestellt. Diese ist bei gesetzten Standardeinstellungen erreichbar über https://x.x.x.x/slmobileApi/help. Wurde ein anderer Ordner für die Webseite eingerichtet, ist der Pfad entsprechend anzupassen. Ein direkter Aufruf ist auch über den Mobile Manager möglich.

Test- und Dokumentationsumgebung – Swagger - Über die Hilfe ist auch die Test- und Dokumentationsumgebung – Swagger erreichbar. Neben einer ausführlichen Dokumentation der API, können hier auch direkt die Funktionalitäten der API getestet werden.

Konfiguration von Standardwerten

Im Datenverzeichnis der Auftragsinstallation befindet sich eine Konfigurationsdatei (api_standardwerte_vorgabe.json). Diese Vorlage stellt die Standardwerte für Aktionen vor, die im normalen Betrieb einen Abfragedialog oder den Lagerdialog öffnen würden. Änderungen an dieser Datei werden ignoriert.

Um diese Vorgaben zu beeinflussen, kann eine Kopie dieser Datei mit dem Namen api_standardwerte.json angelegt werden, in der die gewünschten Optionen im JSON-Format hinterlegt werden können. Die verfügbaren Werte sind auf der Hilfe-Seite der SelectLine API aufgeschlüsselt und beschrieben.

Konfiguration der Selectline API

Im Installationsverzeichnis der Mobilen Anwendungen befindet sich in dem Ordner Webapi eine Konfigurationsdatei (Web.config). Diese Datei enthält unter anderem Optionen zur Konfiguration der SelectLine API.

Authentifizierung

Eine dieser Optionen gibt an, wie lange der Login und die zur Verfügung stehende LoginId ihre Gültigkeit behält. Der Standard dieser Option beträgt 14 Tage. Der Wert und die Option sind in der Datei unter dem Schlüssel „LoginIdValidityPeriod“ zu finden.

Kommunikation mit der SelectLine.Api.Backend.exe

Eine weitere Option ist unter dem Schlüssel MilliSecondsDelayOfCancellation zu finden. Diese Option gibt an, wie lange auf eine Antwort das SelectLine.Api.Backend gewartet werden soll. Es wird empfohlen, den Wert dieser Option nur zu konfigurieren, sofern viele Anfragen parallel ausgeführt werden sollen.