REST-API接口
      返回首页
      1. Help Center
      2. 功能介绍
      3. REST-API接口

      REST-API接口

      目录

      特点 设置 凭证 Python 模块

      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

      Back to Top

      设置

      最新的REST-API文档可以在my.anydesk.com客户门户的文件标签中找到。

      该文档包含设置过程（域、authentication header认证头），用以连接REST-Interface和AnyDesk服务器。

      Back to Top

      凭证

      为了访问您的账户的REST-界面，需要以下内容：

      • 许可证-ID
      • API-密码

      注意：关于REST-API凭证，请联系我们并提供您的客户号码。如果使用的是本地部署许可证，请参考安装指南中的 "控制台命令">"高级命令">"REST-API"。

      Back to Top

      Python 模块

      AnyDesk还提供了一个开源的Python模块和示例脚本来访问REST-API。您可以把它作为实现自己程序的参考，也可以借此快速创建脚本以实现任务的自动化。

      示例脚本包括：

      • 输出您的许可证内的每个连接的会话数据（例如，许可证名称、最大会话限制、命名空间等）。
        在终端中作为文本响应或文件导出为.csv
      • 列出所有通讯录名称及其ID。
      • 列出已添加到您的许可证的所有ID，包括别名（如果有的话）。
      • 系统信息，如活动会话、总会话数、客户端数、在线客户端数等。

      AnyDesk Python REST-API是开源的。请随时自己编写脚本以帮助优化你的工作流程。

      要使用Python模块，只需下载我们GitHub中的文件，并将文件解压到您喜欢的位置。 之后，在位于".../doc/examples/"的 "auth.cfg "中输入REST-API凭证。

      要在我们的Python模块中运行脚本，请为您的操作系统下载并安装最新的Python。

      Back to Top