Enterprise

API für externe Systeme: Benutzer, Produkte, Abrechnungen und Bestellungen austauschen

Illustration: ERP, Lohnbuchhaltung und Benutzerverwaltung verbinden sich über die in lunchlist® enthaltene API mit den Bereichen Benutzer, Produkte, Abrechnungen und Bestellungen

Dein ERP, deine Lohnbuchhaltung oder deine Benutzerverwaltung sollen mit lunchlist® kommunizieren, ohne dass jemand Dateien von Hand verschiebt? Dafür bietet lunchlist® eine API über REST-Schnittstellen. Dieser Beitrag zeigt, welche Funktionen sie bietet und wie die Anbindung realisiert wird.

Eine API (englisch Application Programming Interface) ist eine Programmierschnittstelle. Sie legt fest, wie ein Programm einem anderen Daten liefert oder von ihm entgegennimmt. Statt Dateien von Hand zu exportieren und zu importieren kommunizieren die Systeme dann direkt miteinander.

Was ist die API für externe Systeme und was bedeutet REST?

Die API besteht aus Webschnittstellen, über die deine Systeme Daten in lunchlist® lesen und schreiben können. Sie basieren auf REST, einem verbreiteten Standard für Webschnittstellen. Deine Systeme sprechen dabei direkt mit lunchlist®, ein manueller Export und Import ist nicht nötig.

Das spart Wege und vermeidet Zwischenschritte. Daten müssen nicht per E-Mail verschickt oder von Hand in ein anderes System übertragen werden. Ob sich das für deinen Betrieb lohnt, hängt davon ab, wie oft sich Daten ändern und welche Systeme beteiligt sind. Dein IT-Team oder dein Dienstleister kennt das Prinzip von REST in der Regel bereits.

Illustration: lunchlist® und deine Systeme (ERP, Lohnbuchhaltung, Benutzerverwaltung) tauschen Daten über die REST-API mit API-Token aus, mit den Funktionen Benutzer anlegen, aktualisieren und löschen, Produkte abfragen, anlegen und aktualisieren, Abrechnungen abfragen und Bestellungen erfassen

Die Grafik zeigt das Prinzip: lunchlist® und deine Systeme kommunizieren über die REST-Schnittstelle, der Zugang läuft über einen API-Token. Alternativ arbeitest du weiterhin mit Dateien, zum Beispiel mit manuellem Import und Export per Excel oder CSV.

Wie läuft der Zugriff über API-Token?

Der Zugriff auf die Schnittstellen läuft über API-Tokens. Ein Token weist dein System gegenüber lunchlist® aus. Ohne gültigen Token erhält das externe System keinen Zugriff.

Behandle einen Token wie ein Passwort. Er gehört nur in die Systeme, die ihn wirklich brauchen. Wie Tokens ausgestellt, verwaltet und widerrufen werden, klären wir in der Abstimmung mit dir.

Welche Funktionen stehen zur Verfügung?

Die API bietet beispielsweise Funktionen für Benutzer, Produkte, Abrechnungen und Bestellungen. Sie lassen sich in drei Gruppen einteilen: Daten in lunchlist® schreiben, Daten abfragen und Bestellungen erfassen.

FunktionRichtungBeispiel für den Einsatz
Benutzer anlegenschreibenNeue Mitarbeitende aus der Benutzerverwaltung übernehmen
Benutzer aktualisierenschreibenÄnderungen aus dem Personalstamm nachziehen
Benutzer löschenschreibenAusgeschiedene Mitarbeitende entfernen
Produkte abfragenauslesenProduktdaten in einem anderen System nutzen
Produkte anlegenschreibenNeue Produkte aus einem führenden System übernehmen
Produkte aktualisierenschreibenÄnderungen an Produkten aus einem führenden System nachziehen
Abrechnungen abfragenauslesenAbrechnungsdaten an ERP oder Lohnbuchhaltung übergeben
Bestellungen erfassenschreibenBestellungen aus einem anderen System in lunchlist® eintragen

Das sind nur Beispiele. Was du genau benötigst, besprechen wir gemeinsam.

Ein Beispiel zeigt, wie die Funktionen zusammenspielen: Neue Mitarbeitende werden in deiner Benutzerverwaltung angelegt. Ein Abgleich, zum Beispiel einmal nächtlich, legt sie in lunchlist® an. Ändert sich die Benutzergruppe, wird der Benutzer aktualisiert. Verlassen sie das Unternehmen, werden die Benutzer gelöscht. Am Monatsende fragt dein ERP die Abrechnungen ab und verarbeitet sie weiter. Wie dein Ablauf aussieht, legst du mit deinen Systemen fest.

Was ist Standard und was wird kundenspezifisch umgesetzt?

Alle diese Schnittstellen setzen wir kundenspezifisch um und bauen dabei auf der bestehenden API als Basis auf. Den Umfang stimmen wir individuell mit dir ab. Welche Funktionen du brauchst, klären wir gemeinsam im Gespräch.

Das Enterprise-Paket umfasst die Umsetzung. Sein Preis richtet sich nach deinen Anforderungen.

Wann lohnt sich die Anbindung per REST statt per Datei?

Immer dann, wenn Daten regelmäßig zwischen lunchlist® und einem anderen System fließen sollen oder viele Änderungen vorhanden sind. Ändern sich die Daten nur selten, kann auch der Excel/CSV-Import ausreichen. Eine Schnittstelle ist grundsätzlich nicht nötig, um lunchlist® zu nutzen.

KriteriumDatei (CSV, Excel)REST-Schnittstelle
AblaufDatei wird erzeugt und im Zielsystem importiertSysteme kommunizieren direkt miteinander
BenutzerImport per Excel oder CSVAutomatischer Abgleich, zum Beispiel einmal nächtlich
AbrechnungAbrechnungsdatei im gewünschten FormatAbrechnungen werden automatisch über die API abgefragt
UmsetzungStandardfunktion oder Format nach deinem WunschKundenspezifisch, Umfang individuell abgestimmt

Wie bekommst du die Schnittstellenspezifikation?

Es gibt eine Schnittstellenspezifikation, die wir dir bei Bedarf zur Verfügung stellen. Gib sie deiner IT oder deinem Dienstleister, damit sich vorab prüfen lässt, ob die Funktionen zu euren Systemen passen. Schreib uns dazu über den Kontakt.

Wie setzen wir die Anbindung gemeinsam um?

Je klarer die Anforderungen sind, desto schneller stimmen wir den Umfang gemeinsam ab. Diese Punkte besprechen wir zusammen mit dir:

  • Welche Systeme sind beteiligt (ERP, Lohnbuchhaltung, Benutzerverwaltung)?
  • Welche Funktionen brauchst du?
  • In welche Richtung sollen Daten fließen und wie oft (zum Beispiel einmal nächtlich)?
  • Wer in deiner IT oder beim Dienstleister spricht mit uns und kennt die Schnittstelle des anderen Systems?

Eine Anbindung ist in der Regel mit überschaubarem Aufwand verbunden. Die technischen Details besprechen wir gerne direkt mit deiner IT oder deinem Dienstleister. Mit dir schließen wir einen Auftragsverarbeitungsvertrag (AVV) ab.

Du willst wissen, was für deine Systeme möglich ist? Im Online-Termin besprechen wir deine Anforderungen und den Umfang der Schnittstellen.