開發

開發客製化解決方案

TeamViewer API

TeamViewer所提供的REST API可以讓您針對客戶環境開發TeamViewer整合功能和應用程式 | 圖示

TeamViewer所提供的網頁式API可以讓您存取資料、控管您的TeamViewer帳戶。您可TeamViewer的功能加入自行開發的應用程式,該程式既可僅適用於您企業環境, 也可供大眾使用。 

API使用REST模式與您的應用程式通訊,並使用OAuth 2.0安全授權標準管理所有資料存取權限。

功能特性

TeamViewer API可為應用程式開發人員提供下列功能: 

使用者管理

與TeamViewer公司設定檔相關的方法(例如建立新的公司成員、修改成員資訊)。 

群組管理

和TeamViewer電腦與聯絡人清單相關的群組方法(例如建立群組、分享群組) 

工作階段管理

和TeamViewer遠端控制工作階段相關的方法(例如建立新的工作階段、修改工作階段資訊)。 

連線報告

和TeamViewer Management Console連線報告相關的方法(例如清單連線報告、匯出報告)。 

線上會議

與TeamViewer會議相關的方法(例如會議排程、開始主動發起會議)

電腦與聯絡人

TeamViewer電腦與聯絡人清單的相關方法(例如檢視線上聯絡人、啟動聯絡人或裝置遠端控制工作階段,或是從通訊錄中批次匯入新聯絡人)。

案件應用範例

  • 從服務台中的客戶支援單建立一個服務案件
  • 將「要求支援工作階段」按鈕整合至您的網頁應用程式。
  • 從TeamViewer Management Console擷取連線報告至Excel,以便進一步處理並產生統計資料。
  • 每晚自動從TeamViewer Management Console匯出連線報告,做為離線或其他目的使用(例如計費)。
  • 快速將整個支援團隊資料匯入您的TeamViewer公司設定檔之中。
  • 自動為Active Directory中的新使用者建立新的TeamViewer帳戶。
  • 在交談App中發起會議,並直接邀請交談夥伴。
  • 在第三方日曆App中進行會議排程。
  • 透過TeamViewer檢視CRM聯絡人是否上線,直接詢問對方是否要啟用遠端控制工作階段
  • 使用儲存在電腦與聯絡人清單中的密碼,直接從您最喜歡的資產管理系統連線至電腦。

開始開發

立即開始 文件 範例

立即使用

立即開始使用並開發App或指令碼。TeamViewer API使用OAuth 2.0、指令碼Token以及Client ID。

立即開始開發

輕鬆開發您專屬的應用程式。依照下列步驟指示或直接查詢 API 文件立即開始使用。

TeamViewer API一共有兩種不同的使用方式:使用指令碼或App。

App可由多個不同的帳戶使用。因此,指令碼和App是以不同的方式存取TeamViewer資料,使用的Token類型亦不相同。

如果您只想針對自己的資料使用此API,請建立指令碼Token。不必擔心,日後如果您改變心意,仍然可以輕鬆轉移至App。如果您想讓其他TeamViewer使用您的App,請建立一個 OAuth 2.0 Client ID。

在TeamViewer Management Console中建立TeamViewer帳戶,使用TeamViewer API開發App與指令碼 | 螢幕擷取畫面

建立帳戶

您需要TeamViewer帳戶才能使用TeamViewer API。 

如需詳細說明,請造訪 TeamViewer Management Console 網站。從網頁左方註冊帳號。

建立指令碼

打開您在TeamViewer Management Console中的設定檔配置 | 螢幕擷取畫面

開啟Management Console

若要建立指令碼, TeamViewer Management Console 您必須使用TeamViewer帳戶登入

在TeamViewer Management Console中,從網站右上方開啟您的設定檔配置。

建立您的TeamViewer帳戶可以使用的新指令碼 | 螢幕擷取畫面

建立 指令碼

  1. 輸入您的指令碼名稱
  2. 輸入指令碼說明
  3. 選擇指令碼權限
  4. 儲存指令碼

詳細資訊請參閱API 文件

請記下指令碼屬性資料中的Token,稍後您將會需要這項資料 | 螢幕擷取畫面

記下指令碼Token

記下您最近建立的指令碼屬性資料中的Token。
在開發過程中您將會需要這項Token資料。

關於Token的詳細資料請參閱API 文件

開始撰寫程式碼

現在您可以開始使用API 文件撰寫您專屬的指令碼。或者您也可以在我們的範例指令碼中使用您的Token。

建立應用程式

開啟TeamViewer Management Console中的App功能表 | 螢幕擷取畫面

開啟Management Console

建立應用程式之前,先使用您的TeamViewer帳戶登入 TeamViewer Management Console 您必須使用TeamViewer帳戶登入

在TeamViewer Management Console中,從網頁頁尾開啟App連結。

使用OAuth 2.0方法建立任何TeamViewer帳戶都能夠使用的新App | 螢幕擷取畫面

建立 App

  1. 輸入應用程式名稱
  2. 輸入應用程式說明
  3. 輸入重新導向URI。
    使用者授與應用程式資料存取權限後,將被重新導向至URI。設定完畢後,只有授權要求才能夠使用此重新導向URI。之後仍可再行變更。
  4. 選擇存取層級
  5. 選擇App權限
  6. 儲存App

詳細資訊請參閱API 文件

請記下指令碼屬性中的Token,稍後您將會需要使用這項資料 | 螢幕擷取畫面

記下Client ID與Client Secret

記下您最近建立的App屬性資料中的Client ID與Client Secret。
在開發過程中您將會需要使用這些資料。

關於Client ID的詳細資料請參閱API 文件。

開始撰寫程式碼

現在您可以開始做使用API 文件撰寫您專屬的應用程式。

API文件

TeamViewer API與其參考資料、規格及方法皆記載在API文件中 | 圖示

TeamViewer API文件提供現有方法的詳細說明(包含方法呼叫範例)與API基本使用資料。

您可以從下方下載PDF格式的TeamViewer API文件。

下載

範例

使用預先建立的指令碼瞭解開發整合功能的基本概念。

我們的範例指令碼

我們提供一些預先建立的指令碼,幫助您立即開始並開發專屬的應用程式。

可用指令碼包括PowerShellPython

下載指令碼以使用 使用者管理, 報告Active Directory 功能,或查看下列範例瞭解基本概念。

詳細的API方法資訊請參閱TeamViewer API 文件。

使用TeamViewer API範例程式碼開發可建立服務案件的應用程式。

程式碼範例:服務佇列

您可以透過服務佇列在TeamViewer與TeamViewer Management Console中管理客戶支援案件。 

這個範例可用來建立服務案件。您可以透過內附的程式碼瞭解如何將服務佇列功能整合到您的應用環境。您可以從下方下載App與C#程式碼。

下載
回到頁首