REST-API da AnyDesk: Guia Completo de Configuração e Utilização em Português

Índice

REST-API

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

Um caso de uso geral para 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 de sua licença
  • Exibir uma lista de sessões dentro de um período de tempo
  • 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 Caderno de Endereços em sua licença

Voltar ao Topo

Configuração

A documentação mais recente da REST-API pode ser encontrada na aba de 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 REST-Interface aos Servidores AnyDesk.

Voltar ao Topo

Credenciais

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

  • ID da licença
  • Senha da API

Observação: Para as credenciais da REST-API, entre em contato conosco e forneça seu número de cliente. Se estiver usando uma licença On-Premises, consulte o Guia de Instalação em “Comandos do Console” > “Comandos Avançados” > “REST-API”.

Voltar ao Topo

Módulo Python

A AnyDesk também oferece 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 criar rapidamente scripts para automatizar tarefas.

Os scripts de exemplo incluem:

  • Saída de dados da sessão de cada conexão feita dentro de sua licença (por exemplo, nome da licença, máximo de sessões, namespaces, etc.) Seja como resposta de texto no terminal ou exportação de arquivo para .csv
  • Listagem de todos os nomes de caderno de endereços e seus IDs.
  • Listagem de todos os IDs que foram adicionados à sua licença, incluindo o alias, se aplicável.
  • Informações do sistema como sessões ativas, contagem total de sessões, contagem de clientes, clientes online e 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 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, baixe e instale o mais recente Python para seu sistema operacional.

Voltar ao Topo

Publicado em

Deixe um comentário

Seu endereço de e-mail não será publicado

Nenhum comentário ainda