API und Integrationen

Integrieren Sie Xcellerate RMM über die REST-API mit PSA-Tools, Dokumentationsplattformen und eigenen Workflows.

Überblick

Xcellerate RMM bietet eine umfassende REST-API, mit der Sie nahezu jede Ressource der Plattform programmgesteuert lesen und schreiben können – Endpunkte, Gruppen, Patches, Skripte, Alarme, Benutzer und mehr. Die API verwendet JSON über HTTPS und folgt den üblichen REST-Konventionen.

Zusätzlich zur API selbst enthält Xcellerate integrierte Integrationskonnektoren für gängige PSA-Tools (Professional Services Automation) und Dokumentationstools. Diese Konnektoren synchronisieren Daten in beide Richtungen, sodass Sie für gängige Workflows keine eigenen Integrationen entwickeln müssen.

Der Browser der API-Dokumentation mit Endpunktliste und Testbereich

Grundbegriffe

API-Schlüssel – ein Token zur Authentifizierung von API-Anfragen. Wird pro Benutzer auf der Seite Administration erzeugt. Übergeben Sie ihn im Header Authorization: Bearer <key>.
REST-Endpunkt – ein URL-Pfad, der einer Ressource entspricht (z. B. liefert GET /api/v1/endpoints alle Endpunkte, POST /api/v1/scripts/{id}/run führt ein Skript aus).
Webhook – eine Callback-URL, die Xcellerate aufruft, wenn ein bestimmtes Ereignis eintritt (z. B. Alarm ausgelöst, Patch installiert, Endpunkt registriert). Nutzen Sie Webhooks, um externe Workflows in Echtzeit auszulösen.
Integrationskonnektor – eine vorgefertigte Brücke zu einem Drittanbieter-Tool (ConnectWise, Autotask, HaloPSA, IT Glue, Hudu). Wird mit Zugangsdaten und Synchronisationsregeln konfiguriert.
Ratenlimit – die API erlaubt höchstens 60 Anfragen pro Minute und API-Schlüssel. Bei Überschreitung wird die Antwort 429 Too Many Requests zurückgegeben.

Schritt-für-Schritt-Anleitung

API-Schlüssel erzeugen

Gehen Sie zu Administration → API keys → New key. Benennen Sie den Schlüssel (z. B. "PSA-Sync"), wählen Sie den Benutzer, zu dem er gehört, und den Berechtigungsumfang (Vollzugriff oder nur Lesen). Klicken Sie auf Generate. Kopieren Sie den Schlüssel sofort – er wird nur einmal angezeigt.

API-Dokumentation erkunden

Navigieren Sie zu Administration → API → Documentation (oder öffnen Sie https://your-server/api/docs). Die interaktive Dokumentation listet jeden Endpunkt mit Anfrage- und Antwortbeispielen und einer Schaltfläche Try it auf.

Ersten API-Aufruf ausführen

Verwenden Sie einen beliebigen HTTP-Client (curl, Postman, Ihre bevorzugte Programmiersprache). Beispiel: curl -H "Authorization: Bearer YOUR_KEY" https://your-server/api/v1/endpoints gibt ein JSON-Array aller Endpunkte zurück.

Webhook einrichten

Gehen Sie zu Administration → Webhooks → New webhook. Geben Sie die Ziel-URL ein, wählen Sie die zu abonnierenden Ereignisse (z. B. alert.created, endpoint.enrolled) und fügen Sie optional ein Secret zur Signaturprüfung hinzu. Speichern Sie.

PSA-Konnektor konfigurieren

Navigieren Sie zu Administration → Integrations. Klicken Sie auf den Konnektor Ihres PSA-Tools (z. B. ConnectWise Manage). Geben Sie die API-URL, die Zugangsdaten und die Zuordnungsregeln ein (welche Xcellerate-Felder welchen PSA-Feldern entsprechen). Klicken Sie auf Test connection und dann auf Enable sync.

Webhook-Konfiguration mit Ereignisauswahl und Zustellprotokoll

Beispiel: Endpunkt per API anlegen

curl -X POST https://your-server/api/v1/endpoints \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "hostname": "WS-LONDON-042",
    "group_id": "grp_abc123",
    "os": "Windows 11",
    "tags": ["london", "sales"]
  }'

Tipps und Best Practices

Erstellen Sie für jede Integration und jedes Skript separate API-Schlüssel – wird einer kompromittiert, können Sie ihn widerrufen, ohne die anderen zu beeinträchtigen.
Verwenden Sie den Umfang read-only für Schlüssel, die nur Daten abrufen müssen (Reporting, Dashboards).
Implementieren Sie auf der Empfängerseite eine Webhook-Signaturprüfung, um gefälschte Ereignisse abzuwehren.
Halten Sie das Ratenlimit ein (60 Anfragen/Min.). Nutzen Sie für Massenoperationen die Batch-Endpunkte oder bauen Sie eine Verzögerung zwischen den Anfragen ein.
Testen Sie die Zuordnungen des PSA-Konnektors in einer Sandbox- oder Testumgebung, bevor Sie die Synchronisation in der Produktion aktivieren, um doppelte Tickets zu vermeiden.
Beobachten Sie das Webhook-Zustellprotokoll auf fehlgeschlagene Zustellungen – sie können darauf hinweisen, dass der empfangende Server ausgefallen ist oder Nutzdaten ablehnt.

Die API unterstützt Paginierung über die Abfrageparameter ?page=1&per_page=50. Paginieren Sie beim Abruf großer Datenmengen immer, um Zeitüberschreitungen zu vermeiden.

Zurück

Sicherung und Wiederherstellung