Guia Completo da REST-API AnyDesk: Recursos, Configuração, Credenciais e Módulo Python
REST-API
A REST-API da AnyDesk é uma interface para automatizar a recuperação e armazenamento de informações do banco de dados da sua conta my.anydesk.com e está atualmente disponível para usuários de licenças Premium (Professional, Power, Performance, Enterprise, Standard, Advanced, Ultimate ou On-Premises) no Brasil.
Um caso de uso geral para o nosso serviço REST-API é integrar automaticamente informações do my.anydesk.com em aplicativos de terceiros, como aplicativos de faturamento automatizado ou para coletar dados de sessão.
Recursos
A partir da versão 1.1.1, a REST-API suporta os seguintes comandos:
- Exibir 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 da 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
- Encerrar uma sessão ativa
- Alterar um alias
- Remover um alias
- Listar nome e ID de cada Agenda de Endereços em sua licença
Configuração
A documentação mais recente da REST-API pode ser encontrada na aba 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.
Credenciais
Para acessar a interface REST para sua conta, é necessário o seguinte:
- ID da licença
- Senha da API
Observação: Para obter as credenciais da REST-API, entre em contato conosco e forneça o seu número de cliente. Se estiver usando uma licença On-Premises, consulte o Guia de Instalação em “Comandos de Console” > “Comandos Avançados” > “REST-API”.
Módulo Python
A AnyDesk também fornece um módulo Python de código aberto e scripts de exemplo para acessar a REST-API. 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 da sua licença (ex: nome da licença, sessões máximas, namespaces, etc.) Seja como resposta de texto no terminal ou exportação de arquivo para .csv
- Listagem de todos os nomes dos agendas 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 REST-API Python da AnyDesk é 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 a sua localização preferida. Em seguida, insira as credenciais da REST-API no “auth.cfg” localizado em “…/doc/examples/”.
Para executar scripts em nosso módulo Python, faça o download e instale o Python mais recente para o seu sistema operacional.
- Publicado em