REST-API

 

Esta é uma tradução automática. Para a versão original, clique aqui.

Índice

 

A API REST AnyDesk é uma interface para automatizar a recuperação e armazenamento de informações do banco de dados de seu my.anydesk.com e está atualmente disponível para usuários de licença Premium (Professional, Power, Performance, Enterprise ou On-Premises).

Um caso de uso geral para nosso serviço REST-API é integrar automaticamente as informações de my.anydesk.com em Aplicativos de terceiros, como aplicativos de cobrança automatizados ou para coletar dados de sessão.

Recursos


A partir da versão 1.1.1, a API REST suporta os seguintes comandos: 

  • Exibir as informações da licença
  • Mostrar informações da conta (licença, número de clientes etc.)
  • Mostrar a lista de clientes AnyDesk registrados na conta
  • Mostrar detalhes do cliente (como status online, alias etc.)
  • Remover um cliente de sua licença
  • Mostrar uma lista de sessões dentro de um determinado período
  • Mostrar detalhes de uma sessão específica
  • Alterar comentário da sessão
  • Fechar uma sessão ativa
  • Alterar um alias
  • Remover um alias
  • Liste o nome e o ID de cada Catálogo de endereços em sua licença

Voltar ao início

Configuração

A documentação mais recente da API REST pode ser encontrada em guia Arquivos do portal do cliente my.anydesk.com .

Esta documentação contém o processo de configuração (domínio, cabeçalho de autenticação) para conectar a Interface REST aos Servidores AnyDesk.

Voltar ao início

Credenciais

Para acessar a interface REST de sua conta, é necessário o seguinte:  

  • License-ID
  • Senha da API

Observação:   Para obter as credenciais da API REST, entre em contato conosco e forneça seu número de cliente. Se estiver usando uma licença no local, consulte o Guia de instalação em "Comandos do console" > "Comandos Avançados" > "REST-API".

Voltar ao início

Módulo Python

AnyDesk também fornece um de código aberto módulo Python e scripts de exemplo para acessar a API REST. Você pode usá-lo como referência para implementar seus próprios programas ou para criar rapidamente scripts para automatizar tarefas.

Os scripts de exemplo incluem:

  • Saída de dados de sessão de cada conexão feita dentro de sua licença (por exemplo, nome de licença, max sessions, namespaces, etc.)
    Como resposta de texto no terminal ou exportação de arquivo para .csv
  • Listagem de todos os nomes do catálogo de endereços e seus IDs.
  • Listagem de todos os IDs que foram adicionados à sua licença, incluindo o alias, se aplicado.
  • Informações do sistema, como sessões ativas, contagem total de sessões, contagem de clientes, clientes online e muito mais.

A API REST AnyDesk Python é de código aberto. Sinta-se à vontade para escrever scripts para ajudar a otimizar seu fluxo de trabalho.

Para usar o módulo Python, basta baixar os arquivos contidos em nosso GitHub e extrair os arquivos para o local de sua preferência. Depois, insira as credenciais da API REST no "auth.cfg" localizado em ".../doc/examples/".

Para executar scripts em nosso módulo Python, baixe e instale o Python mais recente para seu sistema operacional .

Voltar ao início