REST API aktivieren

Die ComBinder REST API ermöglicht es, Produktdaten, Texte, Merkmale und Produktgruppen von außen per HTTP abzufragen und zu bearbeiten – zum Beispiel über n8n-Workflows oder eigene Skripte. Standardmäßig ist die REST API deaktiviert und muss einmalig in den Einstellungen eingeschaltet werden.

Schritt 1: REST API in den Einstellungen aktivieren

Öffne die ComBinder-Einstellungen und wechsle auf den Tab Rest API. Dort stehen zwei Felder zur Verfügung:

  • Enabled: Haken setzen, um die REST API zu aktivieren.
  • Port: Der TCP-Port, auf dem der integrierte Server lauscht. Standardwert ist 8765. Der Wert lässt sich auf jeden freien Port zwischen 1024 und 65535 ändern, zum Beispiel wenn 8765 bereits durch eine andere Anwendung belegt ist.

Nach dem Speichern startet ComBinder den integrierten Webserver sofort. Der Server läuft im Hintergrund, solange die Anwendung geöffnet ist – ein separater Dienst oder Neustart ist nicht nötig.

Hinweis: Das Ändern der REST-API-Einstellungen erfordert das Benutzerrecht Einstellungen. Ohne dieses Recht ist der Tab schreibgeschützt.

Schritt 2: Erreichbarkeit prüfen

Nach dem Aktivieren ist die API unter http://localhost:8765 (bzw. dem gewählten Port) erreichbar. Ein einfacher Smoke-Test mit curl oder einem HTTP-Client bestätigt, dass der Server antwortet:

curl -s http://localhost:8765/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"geheim"}'

Bei erfolgreicher Anmeldung gibt der Endpunkt ein Bearer-Token zurück, das für alle weiteren API-Aufrufe im Header Authorization: Bearer <token> mitgeschickt wird.

Login und Token

Die REST API verwendet dieselben Benutzerkonten wie der ComBinder-Desktop. Benutzername und Passwort für POST /api/auth/login sind identisch mit den Anmeldedaten der Desktopanwendung. Das zurückgegebene Token ist 24 Stunden gültig und kann jederzeit über POST /api/auth/logout ungültig gemacht werden.

Schritt 3: Workspace öffnen

Die Endpunkte für Produkte (/api/product/…) und Gruppen (/api/group/…) setzen voraus, dass in ComBinder ein Workspace geöffnet ist. Ist kein Workspace aktiv, antworten diese Endpunkte mit einem Fehler. Der Workspace kann entweder manuell im Desktop geöffnet oder per API über POST /api/workspace/open geöffnet werden – letzteres ist sinnvoll bei vollautomatischen Automatisierungsszenarien.

REST API Monitor

Über Fenster → REST API Monitor lässt sich jederzeit eine Übersicht aller eingegangenen API-Anfragen aufrufen – mit Methode, Pfad, Statuscode und Zeitstempel. Das ist hilfreich beim Einrichten von Workflows, um zu prüfen, welche Anfragen ComBinder tatsächlich erhalten hat und wie sie beantwortet wurden.

Firewall und Netzwerkzugang

Standardmäßig antwortet der Server nur auf localhost. Soll die API von einem anderen Rechner im Netzwerk erreichbar sein, muss der gewählte Port in der Windows-Firewall freigegeben werden. Aus Sicherheitsgründen empfiehlt es sich, den Zugang auf vertrauenswürdige IP-Adressen zu beschränken und kein öffentliches Netz ohne zusätzliche Absicherung zu nutzen.

Weiterlesen