Los desarrolladores pueden crear su propia integración para el acceso asistido con informes de conexión a la plataforma de TeamViewer utilizando las API públicas de TeamViewer.
Se recomienda encarecidamente leer la documentación de la API para obtener una descripción detallada de las funcionalidaddes utilizada a continuación y para otras como por ejemplo, el acceso desatendido, que pueden incluirse a través de las API públicas.
Las llamadas a la API utilizan un token de portador para la autorización que permite la comunicación con el backend de TeamViewer. Este token puede obtenerse como un token de script a través de la Management Console de TeamViewer (Classic) o (recomendado y descrito aquí) a través del procedimiento Oauth, véase a continuación.
Una vez implementado, OAuth puede utilizarse para obtener un token de portador de TeamViewer para cada usuario de la plataforma. Permitiéndoles conectarse desde la plataforma en la que TeamViewer está integrado utilizando su cuenta de TeamViewer, crear sesiones y obtener informes de conexión.
Este artículo cubrirá las siguientes convocatorias:
- Autenticación mediante OAuth
- Creación de la sesión
- Informes de conexión
📌Nota: Pónte en contacto con un representante de TeamViewer para profundizar en la integración técnica y la colaboración comercial, incluido el uso de las marcas comerciales de TeamViewer.
Este artículo se aplica a los desarrolladores que quieren construir una integración con TeamViewer.
Requisitos previos
Para autenticarse con el backend TeamViewer (se necesita una cuenta TeamViewer, que puede crearse gratuitamente en: https://login.teamviewer.com
💡Sugerencia: se recomienda utilizar una cuenta genérica para tu empresa (por ejemplo, [email protected]).
📌Nota: Una vez que la integración está en marcha, todos los usuarios que quieran utilizar la integración necesitan una cuenta de TeamViewer, y la aplicación de los requisitos de la licencia de TeamViewer.
Crear una aplicación client para OAuth
El procedimiento OAuth requiere que el backend proporcione a la aplicación Client ID y Client Secret.
1) Haz clic en tu icono de usuario y selecciona Editar perfil
2) Selecciona las aplicaciones
3) Haz clic en Crear aplicación
4) Dar un nombre significativo a la aplicación
5) Dar a la aplicación una descripción significativa
6) Establece el URI de redirección de tu aplicación
7) Establece los permisos de la aplicación (se requieren informes de sesión, cuenta y conexión)
8) Haz clic en Crear
Puedes crear un token de script para probar las llamadas a la API sin OAuth.
OAuth
Para que los usuarios puedan obtener un token de portador para los usuarios habituales, la aplicación debe proporcionar la siguiente funcionalidad:
1) Llama para obtener la máscara de inicio de sesión OAuth de TeamViewer (Debe llamarse en un navegador)
He aquí un ejemplo:
💡Sugerencia: El ClientID, Client Secret, y redirect_uri son los mismos creados anteriormente.
2) Esta llamada devuelve un código que debe incluirse en la llamada siguiente junto con el Client secret de tus aplicaciones client
Sesiones de acceso presencial
Una sesión que un experto puede compartir con un cliente final se crea con la siguiente llamada.
Esta convocatoria proporcionará, entre otras informaciones, 3 enlaces:
- Enlace de apoyo
- Enlace de apoyo para el client web
- Enlace del cliente final
Los enlaces de soporte (1 y 2) se mostrarán al experto para activar la conexión TeamViewer desde su lado. El enlace del client web se puede utilizar si la sesión de asistencia se inicia desde el navegador si no se desea una instalación en el lado del usuario.
El enlace del cliente final se mostrará en el lado del cliente final. Una vez que el cliente final haga clic en él, se conectará a la sesión a través del cliente TeamViewer instalado o del módulo TeamViewer Quicksupport .
La llamada a la API
POST: https://webapi.teamviewer.com/api/v1/sessions
Cuerpo:
{
"groupname":"TV_test",
"description": "Issue with configuration of corporate email in domain \\example.com",
"end_customer": {
"name": "John Doe",
"email": "[email protected]"
},
}
Para más detalles, consulta la documentación de la API.
Utiliza el token de portador obtenido a través de OAuth para ejecutar la llamada a la API.
Informes de conexión
Para fines de auditoría y para proporcionar un historial para la documentación, por ejemplo, en un sistema de tickets, TeamViewer proporciona informes de conexión que se pueden obtener con la siguiente llamada:
https://webapi.teamviewer.com/api/v1/reports/connections
La llamada devuelve todas las conexiones, incluyendo sus IDs de sesión.
Documentación de la API
A continuación encontrará más documentación sobre la API.
https://dl.teamviewer.com/integrate/TeamViewer_API_Documentation.pdf
- Documentación de Swagger