SelectLine API
Die SelectLine API (Application Programm Interface) bietet Ihnen die Möglichkeit, über einen einfachen HTTP REST-Service über das Internet, auf Ihren Auftrag zu zugreifen.
Generelle Informationen
Die Toolbox wurde um die Schnittstelle API ergänzt, die mit SelectLine Mobile eingesetzt werden kann.
API ist die Abkürzung für Application Programming Interface und erlaubt mittels einem REST-Service (Repräsentation State Transfer) den Zugriff auf SelectLine-Auftrag hauptsächlich von webbasierenden Lösungen aus. Der Unterschied zur COM-Schnittstelle liegt darin, dass diese für Desktop- und API für Web-Anwendungen konzeptioniert ist. Dazu stehen verschiedene Operationen zur Auswahl. Weitere Informationen können der gesonderten Dokumentation SelectLine API Kurzinfo und der Online-Hilfe entnommen werden.
Details sowie eine vollständige Dokumentation zu den einzelnen Funktionen und Routen entnehmen Sie bitte der API-Hilfe, die mit der jeweiligen Installation zugehörig zur Version installiert wird, oder unserer Demo. Der Link / Aufruf der Hilfe ist nach erfolgter Einrichtung im SelectLine Mobile Manager auf der Seite Webseite zu finden.
Hinweis: Beachten Sie auch die API Update-Hilfe auf der API-Seite unserer Homepage.
Stabilitätsverbesserungen
Das Startverhalten und die Stabilität der API, insbesondere in Bezug auf die Backendprozesse, wurden optimiert und Fehler korrigiert. Sollten Sie Probleme mit der Verfügbarkeit des Backendmanagers haben, empfehlen wir Ihnen nach einem Update auf diese Version die Funktion Datenbank einrichten im Mobile Manager auf der Seite Datenbank erneut auszuführen.
Englische Hilfe
Die API Hilfe steht Ihnen nun auch in englischer Sprache zur Verfügung. Die Sprachauswahl ist am oberen rechten Rand der API-Hilfeseite zu finden. Die Übersetzung ist weitestgehend erfolgt.
Voraussetzung und Freischaltung
Um API anwenden zu können, ist folgendes vorausgesetzt:
- SelectLine-Auftrag ab Skalierung Standard
- SelectLine.mobile Manager (keine SelectLine Mobile-Lizenz nötig)
- Toolbox
SelectLine Mobile wird wegen den entsprechenden Webservices benötigt, zumal die Freischaltung auch darüber erfolgen muss:
Abbildung 15.1: Konfiguration
Wenn alle vorhergehenden Tests erfolgreich waren, können Sie im Bereich Webseite über den Button Im Browser aufrufen die gewünschten Webseiten öffnen.
Abbildung 15.2: API Hilfe
Die API erreichen Sie auf der Startseite unter . Die genaue Beschreibung der API-Funktionen entnehmen Sie bitte der API-Hilfe unter den einzelnen Funktionen.
Abbildung 15.3: Teilauszug API-Funktionen
Die Zuordnung eines Beleges zu einem Projekt kann auch mit der Projektnummer (z.B. "P002") erfolgen. Für das Entfernen einer Projektzuordnung wurde eine eigene Route zur Verfügung gestellt. Die Validierung dieser Routen auf Belegkopf-Ebene wurden um die bereits aus dem SelectLine Auftrag bekannten Prüfungen beim Hinzufügen / Entfernen der Zuordnung erweitert.
Route zum Erzeugen eines Beleg-PDFs
Über die neue Route Documents/{documentKey}/PrintPdf kann unter Angabe der Druckvorlage ein PDF-Dokument erstellt und zurückgegeben werden. Ohne Folgeformulare.
Es gibt drei Routen unter Articles mit denen es möglich ist, die Bilder zu einem Artikel und deren Metadaten abzufragen. Bei der Abfrage eines Bildes kann unter Angabe von gewünschter Höhe und / oder Breite bereits eine serverseitige Skalierung vorgenommen werden, um die zu übertragene Datenmenge zu reduzieren. Bei der Skalierung wird das Seitenverhältnis eines Bildes immer beibehalten und das Bild entsprechend der angegebenen Werte eingepasst.
Route zum Anlegen eines Journals an einem Beleg
Zum Anlegen eines Journals an einem Beleg wird eine neue vereinfachte Route angeboten „POST /Documents/{documentKey}/Journals“. Die alte Route „POST /Journals“ ist mit dieser Version als veraltet gekennzeichnet worden und wird mit der Version 23.2 entfernt.
Fertigungsauftrag per Fertigungsliste anlegen
Die Route zum Anlegen von Fertigungsaufträgen POST /ProductionOrders wurde um die optionale Angabe einer Fertigungslistennummer „ProductionListIdentifier“ und einer Liste der Ergebnisartikel „ManufactureArticles“ mit der Bedarfsmenge erweitert. So können Sie nun Fertigungsaufträge per Standard-Fertigungsliste aus dem Artikelstamm oder per gewünschter Fertigungslistennummer anlegen. Die Bedarfsmengen können nun für mehrere Ergebnisartikel erfasst werden.
Verkaufs- und Einkaufspreis abfragen
Es gibt zwei neue API-Routen, mit der die Verkaufspreise und Einkaufspreise eines Artikels für einen Kunden bzw. Lieferanten abgefragt werden können.
Kunden Verkaufspreise: GET
/Articles/{articleNumber}/Sales/Prices/{customerNumber}
Lieferanten Einkaufspreise: GET
/Articles/{articleNumber}/Purchasing/Prices/{supplierNumber}
Die Ermittlung der Preise berücksichtigt die Mandanteneinstellungen zur Preisfindung der Belege und spiegelt somit die Konstellationen wieder, die beim Erfassen einer Belegposition auch berücksichtigt werden. Die Preise werden immer in der Mandantenwährung ermittelt. Optional kann ein Datum angegeben werden, zu welchem der Preis ermittelt werden soll und festgelegt werden, ob nur Nettopreise zurückgegeben werden sollen. Mengenstaffeln werden abgebildet, indem unter dem Wert „Quatity“ angegeben wird, ab welcher Menge der Preis gilt. Im Wert „OriginKindFlag“ wird die Herkunft des Preises (z.B. 1 – Aktionspreis) mitgeteilt.
Journale von Artikeln und Geschäftspartner abfragen
Für das Abfragen von Journalen stehen Ihnen nun folgende neue Routen zur Verfügung:
- Artikel: GET /Articles/{articleNumber}/JournalsArtikel: GET /Articles/{articleNumber}/Journals
- Kunden: GET /Customers/{customerNumber}/Journals
- Lieferanten: GET /Suppliers/{supplierNumber}/Journals
- Interessenten: GET /Prospects/{prospectNumber}/Journals
- Mitarbeiter: GET /Employees/{employeeNumber}/Journals
Manuelle Lagerung mit einer Belegnummer
Die Route zur Anlage einer manuellen Lagerung POST / ManualStorages wurde um die Angabe der Belegnummer erweitert, sodass Sie nun im Element „Number“ eine selbstdefinierte Belegnummer übermitteln können.
Journal Routen für manuelle Lagerung
Für das Abrufen und Erstellen von Journalen an manuellen Lagerungen wurden zwei neue Routen unter "ManualStorage" bereitgestellt.