X-ERP Hilfe

01. Schnellstart

Vom freigegebenen API-Konto zum ersten erfolgreichen Katalogaufruf in einer Testfirma.

Ziel

Sie melden einen API-Benutzer an und lesen anschließend den Artikelkatalog für einen freigegebenen Geschäftspartner. Erst danach folgen schreibende Geschäftsprozesse. Alle Beispiele setzen eine Testfirma voraus.

Vor dem ersten Aufruf

Lassen Sie sich vom Betreiber die HTTPS-Basisadresse, den exakten Firmendatenbanknamen, ein API-Konto, eine erlaubte PartnerId und Testartikel geben. Für den ersten Katalogaufruf benötigt das Konto Webshop-Read. Die PartnerId bezeichnet einen Geschäftspartner in X-ERP, beispielsweise einen Kunden; sie bezeichnet nicht automatisch den Entwickler oder Fachhändler.

Schritt 1: API-Konto anmelden

Der geprüfte Servercode stellt POST /api/WebApiUser/WebApiLogin bereit. Verwenden Sie Content-Type: application/json.

{"email":"api@example.invalid","password":"IHR_PASSWORT","databaseName":"TESTFIRMA","rememberMe":false,"keepLoggedIn":false}

Bei Erfolg antwortet der geprüfte Controller mit HTTP 200 und {"message":"Login successful."}. Der HTTP-Client muss das über Set-Cookie erhaltene Sitzungscookie speichern. Die Login-Antwort ist kein APIEntityResponse und enthält keinen Bearer-Token. Der Endpunkt ist nicht Teil der ursprünglichen fh-Allowlist; lassen Sie diesen Anmeldeweg für Ihre Installation bestätigen.

Schritt 2: Artikel lesen

Senden Sie mit derselben HTTP-Sitzung und dem erhaltenen Cookie:

GET /api/Webshop/GetArticles?PartnerId=123
Accept: application/json

Ersetzen Sie 123 durch die freigegebene PartnerId. Prüfen Sie HTTP-Status, JSON-Inhalt und success. Erwartetes Antwortmuster, keine garantierte vollständige Artikelstruktur:

{"success":true,"data":[],"errorMessages":[]}

Eine leere Liste ist ein mögliches Ergebnis. Die konkreten DTO-Felder stehen in der OpenAPI-Datei. Prüfen Sie mit einem bekannten Testartikel insbesondere Artikelkennung, Preis und Verfügbarkeit.

Schritt 3: Ergebnis bewerten

  • HTTP 200 und success=true: fachlich erfolgreicher Aufruf.
  • HTTP 200 mit HTML statt JSON: möglicherweise auf eine Loginseite weitergeleitet; Sitzung und Zieladresse prüfen.
  • HTTP 401 oder Login-Weiterleitung: Anmeldung oder Cookie fehlt beziehungsweise ist abgelaufen.
  • HTTP 403: benötigtes WebApi-Recht prüfen.
  • HTTP 200 und success=false: errorMessages auswerten.

PowerShell-Vorlage

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

Nach Bereitstellung des Entwicklerpakets: Entpacken Sie es, lesen Sie README.txt und starten Sie unter PowerShell 7:

./quickstart.ps1 -BaseUrl https://ihr-server.example -DatabaseName TESTFIRMA -PartnerId 123

Das Skript fragt die Zugangsdaten interaktiv ab und führt ausschließlich Anmeldung und Katalogabfrage aus. Es wurde syntaktisch geprüft, aber nicht gegen Ihre produktive X-ERP-Installation ausgeführt.

Nächster Schritt

Lesen Sie Anmeldung und Berechtigungen, bevor Sie Warenkorb oder Bestellungen anbinden. Jede Integration benötigt eine eigene Prüfung ihrer Firmen- und Kundenzuordnung.