REST-API

Inhaltsverzeichnis

 

Die AnyDesk REST-API ist eine Schnittstelle zur Automatisierung des Abrufs und der Speicherung von Datenbankinformationen aus Ihrem my.anydesk.com-Konto und ist derzeit verfügbar für Nutzer von Premium-Lizenzen (Professional, Power, Performance, Enterprise, Standard, Advanced, Ultimate, or On-Premises).

Ein allgemeiner Anwendungsfall für unseren REST-API-Dienst ist die automatische Integration von Informationen aus my.anydesk.com in Anwendungen von Drittanbietern, wie z. B. automatisierte Rechnungsanwendungen, oder zur Erfassung von Sitzungsdaten.

Funktionen


Ab Version 1.1.1 unterstützt die REST-API die folgenden Befehle:
  • Lizenzinformationen anzeigen
  • Kontoinformationen anzeigen (Lizenz, Anzahl der Clients usw.)
  • Liste der für das Konto registrierten AnyDesk-Clients anzeigen
  • Client-Details anzeigen (z. B. Online-Status, Alias usw.)
  • Einen Client aus Ihrer Lizenz entfernen
  • Eine Sitzungsliste innerhalb eines bestimmten Zeitrahmens anzeigen
  • Details zu einer bestimmten Sitzung anzeigen
  • Sitzungskommentar ändern
  • Eine aktive Sitzung schließen
  • Einen Alias ändern
  • Einen Alias entfernen
  • Name und ID jedes Adressbuchs in Ihrer Lizenz auflisten

Zurück nach oben

Setup

Die neueste REST-API-Dokumentation finden Sie auf der Registerkarte "Dateien" des my.anydesk.com-Kundenportals.

Diese Dokumentation umfasst den Setup-Prozess (Domain, Authentifizierungs-Header), um die REST-Schnittstelle mit den AnyDesk-Servern zu verbinden.

Zurück nach oben

Anmeldeinformationen

Um auf die REST-Schnittstelle für Ihr Konto zugreifen zu können, benötigen Sie folgende Angaben:

  • Lizenz-ID
  • API-Passwort

Hinweis: Setzen Sie sich für die Anmeldeinformationen für die REST-API mit uns in Verbindung und geben Sie Ihre Kundennummer an. Wenn Sie eine On-Premises-Lizenz verwenden, finden Sie weitere Informationen in der Installationsanleitung unter "Konsolenbefehle" > "Erweiterte Befehle" > "REST-API".

Zurück nach oben

Python-Modul

AnyDesk bietet auch ein Open-Source-Modul für Python und Beispielskripte für den Zugriff auf die REST-API. Sie können es als Referenz für die Implementierung Ihrer eigenen Programme oder zur schnellen Erstellung von Skripten zur Automatisierung von Aufgaben verwenden.

Die Beispiel-Skripte umfassen:

  • Ausgabe der Sitzungsdaten jeder Verbindung, die innerhalb Ihrer Lizenz hergestellt wurde (z. B. Lizenzname, maximale Sitzungen, Namespaces, usw.)
    Entweder als Textantwort im Terminal oder als Dateiexport in .csv
  • Auflistung aller Adressbuchnamen und ihrer IDs.
  • Auflistung aller IDs, die zu Ihrer Lizenz hinzugefügt wurden, einschließlich des Alias, falls zutreffend.
  • Systeminformationen wie aktive Sitzungen, Gesamtzahl der Sitzungen, Anzahl der Clients, Online-Clients und mehr.

Die AnyDesk-REST-API für Python ist Open-Source. Sie können gerne selbst Skripte schreiben, um Ihren Arbeitsablauf zu optimieren.

Um das Python-Modul zu verwenden, laden Sie einfach die in unserem GitHub enthaltenen Dateien herunter und entpacken Sie die Dateien an den von Ihnen gewünschten Ort. Geben Sie anschließend die REST-API-Anmeldeinformationen in die "auth.cfg" ein, die sich in ".../doc/examples/" befindet.

Um Skripte in unserem Python-Modul auszuführen, laden Sie bitte die neueste Version von Python für Ihr Betriebssystem herunter und installieren Sie diese.

Zurück nach oben