Wie nutze ich die HelpDesk Web API mit KI-Tools wie Copilot, Codex oder Claude?

KI-Tools wie Copilot, Codex, Claude oder andere Agenten können den i-net HelpDesk über die Web API verwenden. Sie können damit Daten lesen und je nach Berechtigung auch Aktionen ausführen.

Was konkret mit der Web API möglich ist, hängt vor allem von den verfügbaren Endpunkten und den Rechten des verwendeten Benutzers ab. Typische Anwendungsfälle sind das Lesen und Auswerten von Tickets, das Abrufen von Inventardaten, das Zusammenfassen von Vorgängen oder das Vorbereiten von Antworten. Entscheidend ist dabei immer: Der Agent kann nur das tun, was über die Web-API bereitgestellt wird und wofür sein Benutzer berechtigt ist.

Benötigte Plugins

Für die technische Anbindung müssen zunächst die passenden Plugins installiert und aktiviert werden. Zwingend erforderlich ist das Plugin Web API. Wenn der Zugriff über einen stateless Bearer-Token erfolgen soll, wird zusätzlich Token Authentication benötigt.

Berechtigungen

Anschließend sollte ein eigener technischer Benutzer für den Agenten angelegt werden. Dieser Benutzer benötigt mindestens das Recht Web API Zugriff sowie alle fachlichen Rechte für die Bereiche, auf die der Agent später zugreifen soll.

Wenn der Agent Tickets lesen soll, braucht er die entsprechenden Ticket- und Rollenrechte. Wenn er mit Inventardaten arbeiten soll, benötigt er mindestens Zugriff auf das Inventar. Ohne diese Fachrechte ist die API-Anbindung zwar technisch vorhanden, der Agent kann aber fachlich nicht sinnvoll arbeiten.

Für diesen Benutzer wird dann ein Bearer-Token zur Authentifizierung erzeugt, das sicher gespeichert werden muss, zum Beispiel im Secret Store des verwendeten Tools, und nicht offen in Chats oder Prompts auftauchen. Im Bearer-Token selbst können ebenfalls Berechtigungen für bestimmte Endpunkte festgelegt werden, um den Agenten zu beschränken.

Dem Benutzer sollten keine weiteren Login-Mechanismen erteilt werden, damit ausschließlich über Token gearbeitet wird. Der Hintergrund ist: der i-net HelpDesk hat eine geringere Speicherlast, wenn viele WebAPI-Zugriffe durchgeführt werden. Würde eine klassische Basic-Auth durchgeführt werden, würde dies den Server stärker belasten.

API-Zugriff

Sobald das eingerichtet ist, werden dem KI-Tool im Regelfall die Basis-URL des HelpDesk, die passende Swagger- beziehungsweise OpenAPI-Beschreibung und der Authorization-Header mitgegeben. Die wichtigsten Swagger-URLs sind meist:

  • https://<server>/api/swagger.json: für die globale API
  • https://<server>/api/ticket/swagger.json: für die Ticket-API
  • https://<server>/api/inventory/swagger.json: für die Inventar-API
  • Weitere Endpunkte können der WebAPI-Anwendung entnommen werden.

Damit hat der Agent alles, was er braucht, um die verfügbaren Endpunkte zu erkennen und korrekt zu verwenden.