WSE Cloud-ERP verfolgt einen API-First-Ansatz: Über die Schnittstellen können Sie Geschäftsdaten mit anderen Anwendungen verbinden und wiederkehrende Abläufe automatisieren. Typische Anwendungsfälle sind die Übernahme von Kunden und Produkten, die Verarbeitung von Abrechnungsdaten und die Bereitstellung von Daten für Auswertungen.
Die WSE API-Referenz öffnen: Dort finden Sie die verfügbaren Endpunkte, Parameter, Datenmodelle und Codebeispiele nach Funktionsbereichen.
REST: Geschäftsvorgänge über die API steuern #
Die REST-API stellt Funktionen von WSE über HTTP bereit. Je nach Endpunkt können Sie Daten lesen, anlegen, ändern oder löschen. Strukturierte Anfragen und Antworten verwenden überwiegend JSON; Dokument- und Datei-Endpunkte können andere Formate liefern.
Über die API lassen sich beispielsweise Kundenstammdaten synchronisieren, Produkte verwalten und Abrechnungsprozesse in eigene Anwendungen oder Workflows einbinden. Welche Operationen verfügbar sind und welche Angaben sie benötigen, beschreibt der jeweilige Endpunkt in der API-Referenz.
OData: Daten für Auswertungen abrufen #
Für lesende Auswertungen bietet das Reporting-Modul einen OData-Zugang. Darüber können berechtigte Anwendungen verfügbare Datensätze gezielt abfragen, Felder auswählen, Ergebnisse filtern und sortieren sowie größere Ergebnismengen seitenweise abrufen. OData ergänzt damit die REST-Funktionen für Geschäftsvorgänge um einen standardisierten Abfragezugang.
Der Service liegt unter /reporting/v1/odata/; die zugehörige Beschreibung des Datenmodells unter /reporting/v1/odata/$metadata. Diese Pfade beziehen sich auf die API-Adresse Ihrer WSE-Installation.
Voraussetzung sind das freigeschaltete Reporting-Modul und die passenden Leseberechtigungen. Für Daten aus weiteren Zusatzmodulen gelten zusätzlich deren Freigaben. Der OData-Zugang dient dem Lesen von Daten; Änderungen erfolgen über die dafür vorgesehenen REST-Endpunkte. Unterstützt wird ein definierter OData-Funktionsumfang. Bei der Auswahl eines Auswertungswerkzeugs müssen dessen Abfrage- und Anmeldeverfahren dazu passen.
Die Endpunkte finden Sie im Bereich Reporting der API-Referenz.
OAuth2: API-Zugriffe sicher autorisieren #
WSE verwendet OAuth2 und OpenID Connect für die Anmeldung und die Bereitstellung von Zugriffstokens. Geschützte API-Aufrufe benötigen ein gültiges Access Token, das im HTTP-Header als Authorization: Bearer <Access-Token> übermittelt wird.
Ein gültiges Token allein erlaubt noch nicht jede Aktion: Zusätzlich prüft WSE die zugewiesenen Berechtigungen und die freigeschalteten Funktionen. Für eine Integration müssen die passende Client-Konfiguration, das Anmeldeverfahren und die benötigten Rechte für Ihre Installation festgelegt werden.
Behandeln Sie Tokens und Client-Geheimnisse vertraulich, verwenden Sie HTTPS und vergeben Sie nur die Rechte, die Ihre Integration benötigt. Zeitlich begrenzte Tokens müssen entsprechend dem eingerichteten Anmeldeverfahren erneuert oder neu bezogen werden.
OpenAPI und technische Referenz #
Die HTML-Referenz der WSE API ist der zentrale Einstieg für die technische Umsetzung. Sie enthält die Schnittstellen nach Bereichen, darunter Kunden und CRM, Produkte, Abrechnung, Dokumente und Reporting.
Zusätzlich steht die OpenAPI-Spezifikation als JSON für Entwicklungswerkzeuge zur Verfügung, etwa für den Import in API-Clients oder die Generierung von Client-Code. Prüfen Sie über die Versionsauswahl, welche Dokumentation zu Ihrer eingesetzten WSE-Version passt.
Eine Integration vorbereiten #
- Ablauf festlegen: Welche Daten sollen zwischen welchen Anwendungen übertragen werden, und in welche Richtung?
- Zugang abstimmen: API-Adresse Ihrer Installation, OAuth2-Konfiguration, Berechtigungen und benötigte Zusatzmodule klären. Die öffentliche Referenz auf websin.de ist die Dokumentation; produktive Aufrufe richten sich an Ihre WSE-Installation.
- Endpunkte auswählen: Parameter, Pflichtfelder, Datenformate und Antworten in der API-Referenz prüfen.
- Kontrolliert testen: Mit geeigneten Testdaten beginnen und Fehlerantworten, Token-Ablauf und die Verarbeitung mehrerer Ergebnisse berücksichtigen. Schreibende Aufrufe nach einem Verbindungsabbruch nicht ungeprüft wiederholen, damit keine doppelten Geschäftsvorgänge entstehen.
Für die Abstimmung einer Anbindung können Sie WebSin kontaktieren. Hilfreich sind die beteiligten Systeme, die benötigten Daten und eine kurze Beschreibung des gewünschten Ablaufs.