Les développeurs peuvent créer leur propre intégration pour l'accès assisté avec rapports de connexion à la plateforme TeamViewer en utilisant les API publiques de TeamViewer.
Il est fortement recommandé de lire la documentation de l 'API pour une description détaillée de la fonctionnalité utilisée ci-dessous et pour d'autres fonctionnalités (par exemple, l'accès non surveillé), qui peuvent être incluses via des API publiques.
Les appels API utilisent un jeton de porteur pour l'autorisation afin de permettre la communication avec le backend TeamViewer. Ce jeton peut être obtenu comme jeton de script via la TeamViewer (Classic) Management Console ou (recommandé et décrit ici) via la procédure Oauth décrite ci-dessous.
Une fois mis en place, OAuth peut être utilisé pour obtenir un jeton de porteur de TeamViewer pour chaque utilisateur de la plateforme. Cela leur permet de se connecter à partir de la plateforme où TeamViewer est intégré en utilisant leur compte TeamViewer, de créer des sessions et d'obtenir des rapports de connexion.
Cet article couvre les appels suivants :
- Authentification via OAuth
- Création de la session
- Rapports de connexion
📌 Note : Veuillez prendre contact avec un représentant de TeamViewer pour une intégration technique et une collaboration commerciale plus poussées, y compris pour l'utilisation des marques de TeamViewer.
Cet article s'applique aux développeurs qui veulent construire une intégration avec TeamViewer.
Prérequis
Pour s'authentifier auprès du backend TeamViewer, il faut disposer d'un compte TeamViewer, qui peut être créé gratuitement à l'adresse suivante : https://login.teamviewer.com.
💡 Astuce : Nous vous recommandons d'utiliser un compte générique pour votre entreprise (par exemple, [email protected]).
📌 Note : Une fois l'intégration en place, tous les utilisateurs qui souhaitent l'utiliser ont besoin d'un compte TeamViewer, et les conditions de licence TeamViewer s'appliquent.
Créer une application client pour OAuth
La procédure OAuth exige que le backend fournisse à une application cliente l'identifiant et le secret du client.
1. Cliquez sur votre icône d'utilisateur et sélectionnez Editer le profil.
2. Sélectionnez Apps.
3. Cliquez sur Créer une application.
4. Donnez un nom significatif à l'application.
5. Donnez à l'application une description significative.
6. Définir l'URI de redirection de votre application.
7. Définissez les autorisations de l'application (les rapports de session, de compte et de connexion sont nécessaires).
8. Cliquez sur Créer.
Vous pouvez créer un jeton de script pour tester les appels d'API sans OAuth.
OAuth
Pour permettre aux utilisateurs d'obtenir un jeton au porteur pour les utilisateurs réguliers, l'application doit fournir la fonctionnalité suivante :
1. Appel pour obtenir le masque de connexion OAuth TeamViewer (Doit être appelé dans un navigateur).
Voici un exemple :
💡 Astuce : Le Client ID, le Client Secret et le redirect_uri sont les mêmes que ceux créés précédemment.
2. Cet appel renvoie un code qui doit être inclus dans l'appel ci-dessous avec le secret de l'application cliente.
Sessions pour l'accès assisté
Une session qu'un agent peut partager avec un client final est créée avec l'appel suivant.
Cet appel fournira, entre autres informations, 3 liens :
- Lien d'assistance
- Lien d'assistance pour le client Web
- Lien du client final
Les liens d'assistance (1 & 2) doivent être montrés àç l'agent pour activer la connexion TeamViewer de son côté. Le lien client Web peut être utilisé si la session d'assistance doit être lancée à partir du navigateur et si aucune installation n'est souhaitée du côté de l'agent.
Le lien du client final sera affiché du côté du client final. Une fois que le client final aura cliqué dessus, il se connectera à la session via le client installé TeamViewer ou le module TeamViewer Quicksupport.
L'appel API
POST : https://webapi.teamviewer.com/api/v1/sessions
Corps :
{
"groupname":"TV_test",
"description": "Issue with configuration of corporate email in domain \\example.com",
"end_customer": {
"name": "John Doe",
"email": "[email protected]"
},
}
Pour plus de détails, veuillez consulter la documentation de l'API.
Utilisez le jeton de porteur obtenu via OAuth pour exécuter l'appel API.
Rapports de connexion
À des fins d'audit et pour fournir un historique pour la documentation, par exemple dans un système de billetterie, TeamViewer fournit des rapports de connexion qui peuvent être obtenus avec l'appel suivant :
https://webapi.teamviewer.com/api/v1/reports/connections
L'appel renvoie toutes les connexions, y compris leurs IDs de session.
Documentation de l'API
Veuillez trouver ci-dessous de la documentation supplémentaire sur l'API.
https://dl.teamviewer.com/integrate/TeamViewer_API_Documentation.pdf
- Documentation sur Swagger