REST-API
      返回首頁
      1. Help Center
      2. 功能
      3. REST-API

      如何設定AnyDesk REST-API?

      目錄

      特徵 設置 憑據 Python Module

      AnyDesk REST-API 是一個接口，用於從您的 my.anydesk.com 帳戶自動檢索和存儲數據庫信息，目前可供高級許可用戶(Professional, Power, Performance, Enterprise, Standard, Advanced, Ultimate, or On-Premises)使用。

      我們的 REST-API 服務的一般用例是將來自 my.anydesk.com 的信息自動集成到第三方應用程序中，例如自動計費應用程序或收集會話數據。

       

      特徵



      • 從 1.1.1 版開始，REST-API 支持以下命令：
      • 顯示許可證信息
      • 顯示帳戶信息（許可證、客戶數量等）
      • 顯示註冊到帳戶的 AnyDesk 客戶列表
      • 顯示客戶詳情（如在線狀態、別名等）
      • 從您的許可證中刪除客戶端
      • 在給定時間範圍內顯示會話列表
      • 顯示特定會話的詳細信息
      • 更改會話評論
      • 關閉活動會話
      • 更改別名
      • 刪除別名
      • 列出許可證中每個通訊簿的名稱和 ID



      回到頂部

      設置



      最新的 REST-API 文檔可在 my.anydesk.com 客戶門戶的“文件”選項卡中找到。

      本文檔包含將 REST 接口連接到 AnyDesk 服務器的設置過程（域名、身份驗證標頭).

       

      回到頂部

      憑據

       

      為了訪問您帳戶的 REST 接口，需要以下內容：

      • License-ID
      • API-Password

      注意：要獲取 REST-API 憑據，請聯繫我們並提供您的客戶編號。 如果使用本地許可證，請參閱下面的安裝指南 "Console Commands" > "Advanced Commands" > "REST-API".



      回到頂部

      Python module

       

      AnyDesk 還提供了一個開源 Python 模塊和示例腳本來訪問 REST-API。 您可以將其用作實現自己的程序或快速創建腳本以自動執行任務的參考。

      示例腳本包括：

      • 輸出您的許可證中建立的每個連接的會話數據（例如 許可證名稱、最大會話數、命名空間等）
      • 作為終端中的文本響應或文件導出到 .csv
      • 列出所有通訊簿名稱及其 ID。
      • 已添加到您的許可證的所有 ID 的列表，包括別名（如果已應用）。
      • 系統信息，如活動會話、會話總數、客戶端計數、在線客戶端等。

      AnyDesk Python REST-API 是開源的。 請隨時自行編寫腳本以幫助優化您的工作流程。

      要使用 Python 模塊，只需下載我們 GitHub 中包含的文件並將文件解壓縮到您的首選位置。 然後，在位於“.../doc/examples/”的“auth.cfg”中輸入 REST-API 憑據。

      要在我們的 Python 模塊中運行腳本，請為您的操作系統下載並安裝最新的 Python。

       

       

      回到頂部