开发人员可以使用公共的TeamViewer APIs创建他们自己的集成,用于出席访问与连接报告的TeamViewer 平台。

强烈建议阅读API文档,以了解下面使用的功能的详细描述,以及可以通过公共API包含的进一步功能(如无人值守的访问)。

API调用使用一个承载令牌进行授权,以实现与TeamViewer 后台的通信。这个令牌可以通过TeamViewer 管理控制台作为脚本令牌获得,也可以通过下面描述的Oauth程序获得(建议在此说明)。

一旦实现,可以使用OAuth为每个平台用户从TeamViewer ,获得一个承载令牌。使他们能够使用他们的TeamViewer 账户从TeamViewer 集成到TeamViewer后台的平台上进行连接,并创建会话和获得连接报告。

这篇文章适用于想要与 TeamViewer 构建集成的开发人员。

这篇文章将涵盖以下调用。

  • 通过OAuth进行认证
  • 会议创建
  • 连接报告

📌注意: 请与TeamViewer 代表联系,进行更深入的技术整合和商业合作,包括使用TeamViewer 商标。

先决条件

要在TeamViewer 后台进行认证,需要一个TeamViewer 账户,该账户可在以下网站免费创建:https://login.teamviewer.com

💡提示:我们建议为你的公司使用一个通用账户(如[email protected])。

📌注意:一旦整合到位,所有想要使用整合的用户都需要一个TeamViewer 帐户,而且TeamViewer 许可证要求也适用。

为OAuth创建一个客户端应用程序

OAuth程序要求后端向客户端应用程序提供客户端ID和秘密。

1) 点击你的用户图标,选择编辑个人资料

2) 选择应用程序

3) 点击创建应用程序

4) 给应用程序起一个有意义的名字

5) 给应用程序一个有意义的描述

6) 设置你的应用程序的重定向URI

7) 设置应用程序的权限(会话、账户和连接报告是必需的)。

8) 点击创建

你可以创建一个脚本令牌,在没有OAuth的情况下测试API调用。

OAuth

为了使用户能够获得普通用户的不记名令牌,该应用程序需要提供以下功能。

1) 调用获取TeamViewer OAuth登录掩码(必须在浏览器中调用)。

这里有一个例子:

https://login.teamviewer.com/oauth2/authorize?response_type=code&client_id=123456-pDPThfDpeAnIXmuEDSSJ&redirect_urihttp://www.google.com&display=popup

💡提示:ClientID、Client Secret和redirect_uri是上面创建的那些。

2) 该调用返回一个代码,需要与你的客户端应用程序的客户秘密一起包含在下面的调用中。

值守会议的访问

支持者可以与终端客户共享的会话是通过以下调用创建的。

这个电话将提供,除其他信息外,3个链接。

  1. 支持者链接
  2. 网页客户端的支持者链接
  3. 终端客户链接

支持者链接(1和2)应显示给支持者,以便从他们那边激活TeamViewer 连接。如果不希望在支持者一方进行安装,支持会话应从浏览器启动,则可使用网络客户端链接。

终端客户的链接将显示在终端客户那边。一旦终端客户点击它,它将通过安装的TeamViewer (Classic) 客户端或TeamViewer (Classic) Quicksupport 模块连接到会议。

API调用

POST:https://webapi.teamviewer.com/api/v1/sessions

主体:

{
"groupname":"TV_test",
"description": "Issue with configuration of corporate email in domain \\example.com",
            "end_customer": {
                "name": "John Doe",
                "email": "[email protected]"
            },
}

进一步的细节,请查看API文档

使用通过OAuth获得的承载令牌来执行API调用。

连接报告

为了审计和提供历史文件,例如在票务系统中,TeamViewer (Classic) ,提供连接报告,可以通过以下调用获得。

https://webapi.teamviewer.com/api/v1/reports/connections

该调用返回所有连接,包括它们的会话ID。

API文档

请在下面找到有关API的进一步文件。

  • PDF

https://dl.teamviewer.com/integrate/TeamViewer _API_Documentation.pdf

  • Swagger文档

https://webapi.teamviewer.com/api/v1/docs/index#/