LoginWebsite

Xentral ERP

Diese Anleitung zeigt dir, wie du den API-Zugang in Xentral aktivierst, einen eigenen API-Benutzer anlegst, einen Token erzeugst und die Verbindung erfolgreich testest. So kannst du Daten aus Xentral abrufen oder automatisiert neue Einträge (z. B. Artikel oder Aufträge) anlegen.

🧰 Voraussetzungen

Bevor du startest, stelle sicher, dass:

  • Du Zugriff auf dein Xentral-System hast (Adminrechte empfohlen)

  • Du eine Xentral-Installation nutzt – entweder Cloud oder Self-Hosted

Die API ist in allen Xentral-Versionen verfügbar, muss aber manuell aktiviert werden.

🔐 Schritt 1: Im Xentral Backend anmelden

  1. Öffne dein Xentral-System in einem Browser: z. B. https://deinname.xentral.biz

  2. Melde dich mit deinen Admin-Zugangsdaten an.

Verwende ein Administratorkonto, um später alle benötigten Einstellungen vornehmen zu können.

👤 Schritt 2: Benutzer für API-Zugriff anlegen (empfohlen)

Es ist best practice, einen separaten Benutzer speziell für API-Zugriffe anzulegen.

  1. Gehe zu Administration → Benutzer

  2. Klicke auf „Neu“

  3. Fülle die Felder aus (z. B. Benutzername: apiuser)

  4. Wechsle zum Reiter „Rechte“

  5. Vergib nur die notwendigen Rechte, z. B.:

    • API

    • Artikel

    • Auftrag

  6. Speichere den Benutzer.

Vergebe niemals unnötig viele Rechte – das minimiert Sicherheitsrisiken.

🧩 Schritt 3: API-Zugang aktivieren

  1. Gehe zu Administration → Einstellungen → System → Grundeinstellungen

  2. Öffne den Reiter „API“

  3. Aktiviere das Kontrollkästchen „API-Zugriff aktivieren“

  4. Klicke auf Speichern

Falls du diesen Menüpunkt nicht siehst, kann es sein, dass dein Benutzer keine Adminrechte hat.

🔑 Schritt 4: API-Token erzeugen (optional)

Xentral verwendet standardmäßig Basic Auth mit Benutzername und Passwort. In manchen Versionen oder Modulen ist zusätzlich die Nutzung eines API-Tokens möglich.

So erzeugst du einen Token:

  1. Gehe zu Administration → Benutzer

  2. Öffne den Benutzer, der für die API verwendet werden soll (z. B. apiuser)

  3. Wechsle zum Reiter „API“ oder „Erweiterungen“

  4. Klicke auf „Token generieren“

  5. Kopiere den Token sofort und speichere ihn sicher ab

API-Tokens werden oft nur einmal angezeigt. Speichere ihn direkt an einem sicheren Ort, z. B. in einem Passwort-Manager.

🧪 Schritt 5: API-Zugriff testen

Du kannst den Zugriff mit Tools wie Postman oder cURL prüfen.

Beispiel: GET-Anfrage (Artikel-Liste abrufen)

URL: https://deinname.xentral.biz/api.php?module=artikel&action=list

Authentifizierung:

  • Methode: Basic Auth

  • Benutzername: apiuser

  • Passwort: dein Passwort oder API-Token

Beispiel mit cURL:

Wenn du eine Antwort mit JSON-Daten bekommst, funktioniert dein API-Zugang korrekt.

📚 Schritt 6: Offizielle API-Dokumentation

Die vollständige Dokumentation findest du hier:

  • Online-Dokumentation: 👉 https://doc.xentral.biz/

  • Direkt im System (je nach Version): 👉 https://deinname.xentral.biz/api.php?showApiDoc=1

In der API-Dokumentation findest du alle verfügbaren Module, Endpunkte und Parameter – z. B. für Artikel, Aufträge, Kunden, Lagerbestände u. v. m.

✅ Ergebnis

Wenn du alle Schritte abgeschlossen hast:

  • Die Xentral-API ist aktiviert

  • Du hast einen dedizierten API-Benutzer

  • Ein Token oder Zugangsdaten sind vorhanden

  • Du kannst erfolgreich auf die API-Endpunkte zugreifen

Dein Xentral-System ist jetzt bereit für externe Integrationen, Automatisierungen und Schnittstellen mit anderen Tools oder Services!

VorherigeTexwareNächsteJTL WAWI

Zuletzt aktualisiert

War das hilfreich?