Os desenvolvedores podem criar sua própria integração para o acesso supervisionado com relatórios de conexão para a plataforma TeamViewer usando as APIs públicas do TeamViewer.
É fortemente recomendada a leitura da documentação API para uma descrição detalhada da funcionalidade utilizada abaixo e para outras funcionalidades (por exemplo, acesso não supervisionado), que podem ser incluídas através de APIs públicas.
As chamadas API utilizam um token portador para autorização para permitir a comunicação com o backend TeamViewer. Este token pode ser obtido como um script token através do TeamViewer (Classic) Management Console ou (recomendado e descrito aqui) através do procedimento OAuth descrito abaixo.
Uma vez implementado, o OAuth pode ser usado para obter um token portador pelo TeamViewer para cada usuário da plataforma. Habilite-os a se conectarem a partir da plataforma onde o TeamViewer está integrado no backend usando sua conta TeamViewer e crie sessões e para obter relatórios de conexão.
Este artigo cobrirá as seguintes chamadas:
- Autenticação via OAuth
- Criação da sessão
- Relatório de conexão
📌Lembrete: Entre em contato com um representante do TeamViewer para uma colaboração comercial com mais informações técnicas e aprofundadas sobre as integrações, incluindo o uso de marcas registradas do TeamViewer.
Este artigo se aplica a desenvolvedores que desejam construir uma integração com TeamViewer .
Pré-requisitos
Para autenticar com o backend TeamViewer , é necessária uma conta TeamViewer, que pode ser criada no Management Console.
💡Dica: Recomendamos o uso de uma conta mestre para sua empresa (por exemplo, administraçã[email protected]).
📌Lembrete: Depois que a integração estiver em vigor, todos os usuários que desejam usar a integração precisam de uma conta do TeamViewer licenciada.
Crie um aplicativo cliente para a OAuth
O procedimento OAuth exige que o backend forneça um aplicativo Client ID e o Client Secret.
1. Clique em seu ícone de usuário e selecione Editar perfil
2. Selecione aplicativos
3. Clique em Criar aplicativo
4. Dê um nome significativo ao aplicativo
5. Dê ao aplicativo uma descrição significativa
6. Defina o redirecionamento do URI de sua aplicação
7. Defina as permissões dos aplicativos (Sessão, conta e relatórios de conexão são necessários)
8. Clique em Criar
Você pode criar um script token para testar as chamadas API sem OAuth.
OAuth
Para que os usuários possam obter um token portador para usuários regulares, o aplicativo precisa fornecer a seguinte funcionalidade:
1. Ligue para obter a máscara de login TeamViewer OAuth (Deve ser chamada em um navegador)
Aqui está um exemplo:
💡Dica: O ClientID, Client Secret e redirect_uri são os mesmos criados acima.
2. Esta chamada retorna um código que precisa ser incluído na chamada abaixo junto com o segredo do cliente dos aplicativos de seu cliente.
Sessões de acesso assistido
Uma sessão que um apoiador pode compartilhar com um cliente final é criada com a seguinte chamada.
Esta chamada fornecerá, entre outras informações, 3 links:
- Link de apoio
- Link de apoio para WebClient
- Link do cliente final
Os links de apoio (1 e 2) devem ser mostrados ao apoiador para ativar a conexão TeamViewer a partir de seu lado. O link WebClient pode ser usado se a sessão de suporte for iniciada a partir do navegador se nenhuma instalação no lado do apoiador for desejada.
O link do cliente final será mostrado no lado do cliente final. Assim que o cliente final clicar nele, ele se conectará à sessão através do cliente TeamViewer instalado ou do módulo TeamViewer Quicksupport.
A chamada API
POST: https://webapi.teamviewer.com/api/v1/sessions
Corpo:
{
"groupname":"TV_test",
"description": "Issue with configuration of corporate email in domain \\example.com",
"end_customer": {
"name": "John Doe",
"email": "[email protected]"
},
}
Para obter mais detalhes, consulte a documentação API.
Use o token ao portador obtido via OAuth para executar a chamada API.
Relatórios de conexão
Para fins de auditoria e para fornecer um histórico para documentação, por exemplo, em um sistema de bilhetagem, TeamViewer fornece relatórios de conexão que podem ser obtidos com a seguinte chamada:
https://webapi.teamviewer.com/api/v1/reports/connections
A chamada retorna todas as conexões, incluindo seus IDs de sessão.