REST/REST-Proxy

Der REST-API-Service, der im Serverbetrieb einen zentralen Zugriff per REST auf die (nicht-visuelle) combit CRM-Schnittstelle ermöglicht, erfordert die Enterprise Edition.

Soll auf einen bereits von Benutzer:innen visuell gestarteten combit CRM-Client lokal (localhost/loopback) ein Zugriff per REST-API erfolgen, so ist dies mit allen Editionen möglich.

Hinweis: In Terminalserver-Umgebungen kann der REST-Proxy aus technischen Gründen nur als "Server-Instanz" und nicht für einzelne Benutzer:innen/Clients gestartet werden.

Die Konfigurationsmöglichkeiten und deren Erklärungen finden Sie in der Datei "appsettings.json" im Unterverzeichnis "\Tools\REST Proxy" Ihrer combit CRM-Installation. Diese Datei wird entweder beim ersten Start des Proxys automatisch erstellt oder kann manuell als Kopie der Datei "appsettings.default.json" bereits vor dem ersten Start eingerichtet werden. Beachten Sie, dass dieser mit administrativen Rechten erfolgen muss.

Nach der Konfiguration kann der REST-Proxy testweise über die ausführbare Datei "combit.CRM.RESTProxy.exe" gestartet werden. Für einen dauerhaften Betrieb empfiehlt sich die Installation als Dienst mithilfe des PowerShell-Scripts "RESTProxy-Service-Install.ps1" im Unterverzeichnis "\Tools\Service Scripts". Beachten Sie auch hier, dass dieses mit administrativen Rechten ausgeführt werden muss.

Wichtig: Ihr IT-Administratorteam sollte sicherstellen, dass REST-Proxy-Instanzen ausschließlich auf dem lokalen Computer oder im internen Netzwerk erreichbar sind. Der Proxy sollte nicht vom Internet aus aufrufbar sein, um Missbrauch vorzubeugen.

Eine Übersicht zur Benutzung des REST-Proxys inkl. einer Liste aller unterstützten Methoden und Eigenschaften können Sie nach dem Start des REST-Proxys über die URL http://localhost:9454/swagger/index.html aufrufen (der Standardport 9454 ist dabei in der o. g. Datei "appsettings.json" selbst konfigurierbar).