Skip to main content

API-Zugang zu TOPdesk

API-Funktionalitäten und Anforderungen

TOPdesk verfügt über eine Anwendungsprogrammierschnittstelle (API). Die API ermöglicht es Ihnen, andere Systeme in TOPdesk zu integrieren. Sie können zum Beispiel ein Widget in Ihr Intranet einfügen, das den Benutzern die aktuellen Incidents oder Reservierungen anzeigt, oder Sie können eine Verknüpfung mit Ihrem Überwachungssystem erstellen, die es den Benutzern ermöglicht, Incidents direkt in TOPdesk zu protokollieren.

Anmerkung

Sie können auf die API über https://[TOPdeskURL]/tas/api/ zugreifen.

Welche Prozesse werden von der API unterstützt?

Der Umfang der API-Unterstützung ist je nach Prozess unterschiedlich. Wir erweitern kontinuierlich die Anzahl der unterstützten Prozesse. Alle verfügbaren APIs finden Sie auf unserer TOPdesk API-Dokumentationsseite.

Kein Handbuch für Einsteiger: Zielgruppe des API-Handbuchs

Das API-Handbuch führt Sie durch die Schritte, die erforderlich sind, um auf die TOPdesk API zuzugreifen, sie anzuzeigen und sie zum Abrufen von Daten aus TOPdesk zu verwenden. Es wird jedoch nicht die verwendeten Techniken erklären: HTTP, REST und JSON. Um dieses Handbuch zu verstehen und zu nutzen, müssen Sie mit dem Datenmodell von TOPdesk und der Formatierung von JSON-Daten vertraut sein.

Anforderungen für den API-Zugang

Bevor Sie auf die API zugreifen können, müssen Sie zunächst Folgendes tun:

  1. Aktivieren Sie die TOPdesk Authentifizierung und/oder LDAP-Authentifizierung im Bearbeiterbereich Ihrer TOPdesk Umgebung.

  2. Erstellen Sie einen Benutzer, der die API aufrufen wird. Wir empfehlen Ihnen, für jede Anwendung, die Zugriff auf die API benötigt, ein separates Bearbeiter- oder Personenkonto zu erstellen, um die Fehlerbehebung zu erleichtern. Ob Sie ein Bearbeiter- oder Personenkonto benötigen, hängt von dem Bereich (Bearbeiterbereich oder Self Service Portal) ab, auf den Sie zugreifen möchten. Stellen Sie sicher, dass der Benutzer über ein TOPdesk und/oder LDAP-Login verfügt.

  3. Erstellen Sie eine Berechtigungsgruppe, welche die Nutzung der API erlaubt. Weisen Sie Leseberechtigungen für die REST-APIund Schreibberechtigungen für Anwendungskennwörter verwenden (im Berechtigungsblock API-Zugriff ) zu.

  4. Verknüpfen Sie den oder die API-Benutzer mit dieser API-Berechtigungsgruppe und mit anderen Berechtigungsgruppen, die sie für den Zugang zu den gewünschten Bereichen von TOPdesk benötigen.

  5. Installieren Sie ein Tool zum Erstellen und Testen von HTTP-Requests. In diesem Handbuch sehen Sie Beispiele mit der Talend API Tester Chrome-Erweiterung (früher bekannt als Restlet Client). Einige der Anweisungen beziehen sich speziell auf dieses Tool, aber Sie können auch ein anderes Tool verwenden. Die meisten Tools funktionieren ähnlich.

    Die Talend-API-Tester-Erweiterung erscheint als lila Polygon-Symbol in Ihrem Browser. Klicken Sie es an, um die Erweiterung zu öffnen.

In diesem Abschnitt: