Splashtop Open API

Splashtop 現在提供 Open API,讓使用者能簡化工作流程,並增強支援能力。

這些 RESTful API 可供所有 Splashtop Enterprise 團隊使用。

使用其他 Splashtop 產品的客戶可在此註冊進行 Beta 測試。

說明文件

在此下載最新的 Open API 參考資料:

Splashtop Open API 參考資料 0.6 版

可用的 API

用於各種網路控制台操作的 API 讓您不須透過 Splashtop 網路控制台手動執行,即可自動執行各種操作。

  • 檢索使用者資訊 (使用者清單、存取權限)
  • 檢索電腦資訊 (電腦清單、電腦基本資訊、詳細目錄)
  • 管理電腦 (刪除電腦、指派電腦到群組)
  • 管理群組 (建立、編輯、刪除、指派使用者/電腦)
  • 檢索記錄檔 (連線、設定記錄、端點管理等)

整合 Splashtop 臨機支援技術的 API 讓您建立類似的工作流程,透過預先建置整合技術如 ServiceNow、Freshservice、Jira Service Desk、Zendesk 等服務來執行各種操作。

  • 建立支援連線連結
  • 啟動連線並連接到使用者的電腦
  • 將工件 (連線記錄檔、檔案傳輸記錄檔、聊天記錄等) 回寫至需求單中

我們將持續新增 API 來提供更多服務。
請參閱我們的下一步 (發展藍圖) 深入了解更多詳細資訊。

 

驗證方式

有兩種方法可進行驗證和授權。

API 權杖 (僅限 Splashtop 團隊擁有者和超級管理員)
  1. 登入網路控制台:my.splashtop.com / my.splashtop.eu
  2. 按一下管理 > 設定 > API
  3. 按一下建立 API 權杖
    pcp_api_zh-tw.png
  4. 設定 API 權杖的範圍到期日
    pcp-api-config_zh-tw.PNG
OAuth 2.0
  1. 請使用此處的表單與我們聯繫,為您的商業軟體或 Splashtop 帳戶新增 OAuth 2.0 應用程式,並向您提供對應的用戶端 ID用戶端密鑰。另外也請您提供重新導向網址
  2. 從網路控制台 my.splashtop.com / my.splashtop.eu 要求驗證碼,並使用以下格式:

    格式
    https://my.splashtop.com/oauth2/authorize?client_id=<client_id>&scope=<scope>&response_type=code&state=<string>&redirect_uri=<callback URL (urlencode)>

    參數
    client_id 我們已為您建立 OAuth 應用程式用戶端 ID (由 Splashtop 提供)
    scope 下列值皆以逗號分隔:
    users,psa,service_desk,logs,team_users,team_computers,
    team_groups,team_access_permission,inventory
    state 定義此變數,確定這是您這端提出驗證要求的連線。稍後可以使用此狀態來產生存取權杖。
    redirect_uri 採用網址編碼格式的重新導向網址


  3. 使用驗證碼換取存取權杖重新整理權杖。存取權杖的 TTL 為 24 小時,重新整理權杖的 TTL 則為 30 天。

    請參閱「Splashtop Open API 參考資料」第 4.1 節「OAuth 2.0」,以了解更多詳細資訊。
5 人中有 3 人覺得有幫助