X-ERP Hilfe

APIs

Entwicklerdokumentation für X-ERP: Schnellstart, Cookie-Login, Berechtigungen, Endpunkte, Beispiele und Downloads – klar gegliedert für die praktische Integration.

OPENAPI · SWAGGERVollständige API-Referenz → Endpunkte finden, Parameter und Datenmodelle nachschlagen und den Integrationsleitfaden lesen.

Ihr Einstieg in die X-ERP APIs

Diese Dokumentation führt vom ersten lesenden Aufruf bis zur fachlich geprüften Integration. Der Standardumfang umfasst 28 Operationen für Geschäftspartner-Sitzungen, Artikelkatalog, Warenkorb, Bestellung und Helpdesk. Der technische API-Login wird separat erklärt.

In dieser Reihenfolge starten

  1. Schnellstart: Testzugang vorbereiten, anmelden und Artikel lesen.
  2. Anmeldung und Berechtigungen: Cookie-Sitzung, Firmenkontext und benötigte Rechte verstehen.
  3. Endpunktreferenz: Routen, Parameter und fachliche Antworten nachschlagen.
  4. Beispiele und Downloads: OpenAPI, PowerShell-Schnellstart und HTTP-Vorlagen verwenden.
  5. Fehlerbehandlung und Betrieb: Fehler, Wiederholungen und Abnahme planen.
  6. Freigaben und Versionshinweise: Standardumfang, Erweiterungen und bekannte Abweichungen prüfen.

Technische Unterlagen

Die OpenAPI-Datei und Beispielvorlagen gehören zum separat bereitzustellenden Entwicklerpaket.

Die OpenAPI-Datei und Beispielvorlagen gehören zum separat bereitzustellenden Entwicklerpaket.

Begriffe kurz erklärt

  • API-Benutzer: Das für die technische Anmeldung freigegebene X-ERP-Konto.
  • Firma: Die über databaseName beim Login ausgewählte Firmendatenbank.
  • PartnerId: Die ID eines X-ERP-Geschäftspartners, beispielsweise eines Kunden. Sie bezeichnet nicht automatisch den Fachhändler oder Entwickler.
  • fh: Technischer Name des kuratierten Swagger-Dokuments für die Standardoperationen.

Stand und Grenzen

Dokumentation und ausgewählte Serverstellen wurden am 18.09.2026 abgeglichen. Ein Live-Test gegen Ihre Zielinstallation ist damit nicht ersetzt. Vor Produktivbetrieb sind insbesondere die Belegzuordnung und Adressübernahme beim Checkout sowie das vollständige Datenmodell für Helpdesk-Schreibzugriffe zu bestätigen. Die konkreten Abweichungen stehen im Kapitel Freigaben und Versionshinweise.

In diesem Kapitel