Entwickler können ihre eigene Integration für den beaufsichtigten Zugriff mit Verbindungsprotokollen zur TeamViewer Plattform unter Verwendung der öffentlichen TeamViewer APIs erstellen.
Es wird dringend empfohlen, die API-Dokumentation zu lesen, um eine detaillierte Beschreibung der nachstehend verwendeten und einigen weiteren Funktionen (z. B. unbeaufsichtigter Zugriff) zu erhalten, die über öffentliche APIs eingebunden werden können.
Die API-Aufrufe verwenden ein Inhaber-Token zur Autorisierung, um die Kommunikation mit dem TeamViewer Backend zu ermöglichen. Dieses Token kann entweder als Skript-Token über die Website TeamViewer (Classic) Management Console oder, wie empfohlen und hier beschrieben, über das OAuth-Verfahren bezogen werden.
Einmal implementiert, kann OAuth verwendet werden, um für jeden Plattformnutzer ein Träger-Token von TeamViewer zu erhalten. Damit können sie sich von der Plattform, auf der TeamViewer integriert ist, mit ihrem TeamViewer Konto verbinden, Sitzungen erstellen und Verbindungsprotokolle abrufen.
In diesem Artikel werden die folgenden Anrufe behandelt:
- Authentifizierung über OAuth
- Erstellen von Sitzungen
- Verbindungsprotokolle
📌 Hinweis: Bitte setzen Sie sich mit einem Vertreter von TeamViewer in Verbindung, um die technische Integration und kommerzielle Zusammenarbeit, einschließlich der Verwendung der Schutzmarke TeamViewer, zu vertiefen.
Dieser Artikel richtet sich an alle, die eine Integration mit TeamViewer erstellen möchten.
Voraussetzungen
Für die Authentifizierung mit dem TeamViewer Backend ist ein TeamViewer Konto erforderlich, das kostenlos erstellt werden kann unter: https://login.teamviewer.com.
💡 Hinweis: Wir empfehlen, ein allgemeines Konto für Ihr Unternehmen zu verwenden (z. B. [email protected]).
📌 Hinweis: Sobald die Integration eingerichtet ist, benötigen alle Benutzer, die die Integration nutzen möchten, ein TeamViewer Konto, und es gelten die TeamViewer Lizenzbestimmungen.
Eine Client-Anwendung für OAuth erstellen
Das OAuth-Verfahren erfordert, dass das Backend eine Client-Applikation bereitstellt, welche Client-ID und Client-Secret enthält.
1. Klicken Sie auf Ihr Benutzersymbol und wählen Sie Profil bearbeiten.
2. Apps auswählen.
3. Klicken Sie auf App erstellen.
4. Geben Sie der App einen aussagekräftigen Namen.
5. Geben Sie der App eine aussagekräftige Beschreibung.
6. Legen Sie die Redirect URI Ihrer App fest.
7. Legen Sie die App-Berechtigungen fest (Sitzungen verwalten, Kontoverwaltung und Verbindung-Protokollierung sind erforderlich).
8. Klicken Sie auf Erstellen.
Sie können ein Skript-Token erstellen, um die API-Calls ohne OAuth zu testen.
OAuth
Um den Nutzern die Möglichkeit zu geben, ein Inhaber-Token für regelmäßige Nutzer zu erhalten, muss die App die folgenden Funktionen bieten:
1. Aufruf um die TeamViewer OAuth Anmeldemaske zu öffnen (muss im Browser aufgerufen werden).
Hier ein Beispiel:
💡 Hinweis: ClientID, Client Secret und redirect_uri sind dieselben, die oben erstellt wurden.
2. Dieser Call gibt einen Code aus, der zusammen mit dem Client-secret Ihrer Client-App in den untenstehenden Call aufgenommen werden muss.
Sitzungen für beaufsichtigten Zugriff
Eine Sitzung, die ein Supporter mit einem Endkunden teilen kann, wird mit dem folgenden Aufruf erstellt.
Dieser Call enthält neben anderen Informationen 3 Links:
- Supporter Link
- Supporter Link für WebClient
- Endkunden Link
Die Supporter-Links (1 & 2) müssen dem Supporter angezeigt werden, um die TeamViewer Verbindung von seiner Seite aus zu aktivieren. Der WebClient-Link kann verwendet werden, wenn die Support-Sitzung vom Browser aus gestartet werden soll und keine Installation auf Seiten des Supporters gewünscht ist.
Der Endkundenlink wird auf der Seite des Endkunden angezeigt. Sobald der Endkunde darauf klickt, wird er über den installierten TeamViewer Client oder das TeamViewer Quicksupport Modul mit der Sitzung verbunden.
Der API-Call
POST: https://webapi.teamviewer.com/api/v1/sessions
Body:
{
"groupname":"TV_test",
"description": "Issue with configuration of corporate email in domain \\example.com",
"end_customer": {
"name": "John Doe",
"email": "[email protected]"
},
}
Weitere Einzelheiten entnehmen Sie bitte der API-Dokumentation.
Verwenden Sie das über OAuth erhaltene Inhaber-Token, um den API-Call auszuführen.
Verbindungsprotokolle
Für Auditing-Zwecke und zur Erstellung einer Historie für die Dokumentation z.B. in einem Ticketsystem stellt TeamViewer Verbindungsprotokolle zur Verfügung, die mit dem folgenden Call abgerufen werden können:
https://webapi.teamviewer.com/api/v1/reports/connections
Der Call gibt alle Verbindungen einschließlich ihrer Sitzungs-IDs aus.
API-Dokumentation
Nachfolgend finden Sie weitere Dokumentation über API.
https://dl.teamviewer.com/integrate/TeamViewer API_Documentation.pdf
- Swagger-Dokumentation