View a markdown version of this page

智慧型資料表整合 - Amazon Quick
先決條件設定智慧資料表開發人員工具OAuth 存取範圍在 Amazon Quick 中設定整合可用動作管理和疑難排解

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

智慧型資料表整合

使用智慧資料表動作連接器，透過自然語言直接在智慧資料表工作區中管理工作表、資料列、報告和搜尋。此整合使用 Smartsheet API。如需詳細資訊，請參閱智慧型資料表文件中的智慧型資料表 API 簡介。

設定此整合包含兩個步驟。首先，您可以在 Smartsheet 中為您選擇的身分驗證方法設定登入資料。然後，您可以在 Amazon Quick 中建立整合，並將其連接到您的 Smartsheet 帳戶。如需有關 Amazon Quick 支援的身分驗證方法的資訊，請參閱 身分驗證方法。

先決條件

設定整合之前，請確定您符合下列要求：

設定智慧資料表開發人員工具

設定 Amazon Quick 之前，請在 Smartsheet 中設定登入資料。您完成的步驟取決於您計劃使用的身分驗證方法。Amazon Quick 支援兩種智慧型資料表的身分驗證方法。如需這些方法的詳細資訊，請參閱 身分驗證方法。

如需智慧型資料表 OAuth 的詳細資訊，請參閱智慧型資料表 API 文件中的 OAuth。

註冊開發人員工具並建立開發人員設定檔

  1. 前往開發人員工具註冊頁面，並註冊您要與應用程式搭配使用的 Smartsheet 帳戶。如需詳細資訊，請參閱 Smartsheet API 文件中的註冊開發人員工具。

  2. 智慧工作表啟用開發人員工具後，請登入智慧工作表應用程式，然後在左下角選擇您的帳戶圖示，然後選擇開發人員工具。

  3. 選擇建立開發人員設定檔，然後輸入設定檔名稱。如需詳細資訊，請參閱 Smartsheet API 文件中的建立您的開發人員設定檔。

提示

智慧工作表建議對 OAuth 應用程式使用專用服務帳戶，而不是個人帳戶。

註冊 OAuth 應用程式

  1. 在智慧工作表開發人員工具中，選擇建立新應用程式。

  2. 填寫表單：

    • 應用程式名稱 – 用於向使用者識別您應用程式的名稱。

    • 應用程式描述 – 整合的簡短描述。

    • 應用程式 URL – 啟動應用程式或登陸頁面的 URL。

    • 應用程式聯絡/支援 – 支援聯絡資訊。

    • 應用程式重新導向 URL – https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

      將 {region} 取代為您的 AWS 區域 （例如 us-east-1)。

  3. 選擇儲存。智慧工作表會產生應用程式用戶端 ID 和應用程式秘密。

  4. 複製用戶端 ID 和用戶端秘密值。在 Amazon Quick 中設定整合時，您需要這些項目。

如需詳細資訊，請參閱 Smartsheet API 文件中的註冊應用程式。

產生 API 存取權杖 （僅限服務身分驗證）

如果您打算使用服務身分驗證而非 OAuth，請產生 API 存取字符。您必須擁有商業或企業計劃才能產生字符。如需詳細資訊，請參閱《智慧型資料表說明中心》中的產生 API 存取字符。

  1. 在智慧工作表應用程式中，選擇左側導覽列底部的帳戶 （設定檔影像），然後選擇個人設定。

  2. 選擇 API 存取索引標籤，然後選擇產生新的存取字符。

  3. 命名權杖，然後選擇確定。立即複製字符值 - 這是它唯一可見的時間。

重要

安全地存放您的存取權杖。具有字符的任何人都可以存取字符擁有者可存取的所有 Smartsheet 資料。請勿將權杖遞交至版本控制系統。如需儲存字符的最佳實務，請參閱 Smartsheet API 文件中的身分驗證。

OAuth 存取範圍

當您設定使用者身分驗證 (OAuth) 時，整合會從 Smartsheet 請求下列存取範圍。這些範圍決定整合可以代表已驗證的使用者執行的操作。如果您改用服務身分驗證 (API 金鑰），整合會使用字符擁有者的完整許可，且範圍不適用。如需詳細資訊，請參閱 Smartsheet API 文件中的存取範圍。

智慧型資料表 OAuth 存取範圍
Scope (範圍) Description
READ_SHEETS 讀取所有工作表資料，包括附件、討論和儲存格資料。
WRITE_SHEETS 插入和修改工作表資料，包括附件、討論和儲存格資料。
注意

存取範圍不會覆寫現有的共用許可。例如，具有 WRITE_SHEETS範圍不允許整合更新使用者只有檢視器層級存取權的工作表。如需詳細資訊，請參閱 Smartsheet API 文件中的資源存取層級。

在 Amazon Quick 中設定整合

完成智慧資料表開發人員工具組態後，請在 Amazon Quick 中建立整合。

  1. 在 Amazon Quick 主控台中，選擇連接器。

  2. 選擇為您的團隊建立索引標籤。

  3. 尋找並選擇 Smartsheet。

  4. 輸入整合詳細資訊：

    • 名稱 – 智慧型資料表整合的描述性名稱。

    • 描述 （選用） – 整合的目的。

  5. 選擇您的連線類型並填入連線設定。如需這些身分驗證方法的詳細資訊，請參閱 身分驗證方法。

    1. 對於使用者身分驗證 (OAuth)，請使用 Smartsheet 開發人員工具應用程式註冊中的用戶端 ID 和用戶端秘密。設定下列欄位：

      • 基本 URL – https://api.smartsheet.com/2.0

      • 用戶端 ID – 來自您的 Smartsheet 開發人員工具應用程式註冊的應用程式用戶端 ID。

      • 用戶端秘密 – 智慧型工作表開發人員工具應用程式註冊中的應用程式秘密。

      • 字符 URL – https://api.smartsheet.com/2.0/token

      • 驗證 URL – https://app.smartsheet.com/b/authorize

      • 重新導向 URL – https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

    2. 對於服務身分驗證 (API 金鑰），請使用智慧型工作表個人設定中的 API 存取權杖。設定下列欄位：

      • API 金鑰 – 從您的個人設定產生的智慧型資料表 API 存取字符。

      • 基本 URL – https://api.smartsheet.com/2.0

      • 電子郵件地址 – 與產生字符的 Smartsheet 帳戶相關聯的電子郵件地址。

  6. 選擇建立並繼續。

  7. 選擇要與之共用整合的使用者。

  8. 選擇下一步。

如需使用者身分驗證，請前往 Connectors > 您的 Smartsheet 連接器名稱，然後選擇登入以完成 OAuth 授權流程。在智慧資料表同意視窗中，選擇允許授予存取權。

重要

透過服務身分驗證，所有動作都會使用 API 權杖擁有者的許可執行。任何可存取此整合的 Amazon Quick 使用者都可以對權杖擁有者可存取的所有 Smartsheet 資源執行動作。根據您的組織安全需求，適當地範圍權杖許可。

注意

如果您使用 Smartsheet Gov、Smartsheet Regions Europe 或 Smartsheet Regions Australia，請為您的環境使用對應的基本 URL：

智慧型資料表區域基礎 URLs
Environment 基本 URL
Smartsheet https://api.smartsheet.com/2.0
智慧型資料表 Gov https://api.smartsheetgov.com/2.0
智慧型資料表區域 歐洲 https://api.smartsheet.eu/2.0
Smartsheet Regions Australia https://api.smartsheet.au/2.0

如需詳細資訊，請參閱 Smartsheet API 文件中的基本 URL。

可用動作

設定整合之後，即可執行下列動作。

智慧型資料表可用動作
Category Action Description
搜尋 清單搜尋 搜尋使用者可針對指定文字存取的所有工作表。
工作表 清單工作表 列出已驗證使用者可存取的所有工作表。
工作表 取得工作表 根據工作表 ID 取得工作表及其資料。
報告 列出報告 列出使用者可存取的所有報告。
報告 檢視報告 根據報告 ID 取得報告詳細資訊。

管理和疑難排解

若要編輯、共用或刪除整合，請參閱 管理現有的整合。

驗證問題

  • OAuth 授權失敗 – 確認用戶端 ID 和用戶端秘密符合您智慧型工作表開發人員工具應用程式註冊中的值。確認 Smartsheet 中的重新導向 URL 完全符合 Amazon Quick 組態中的 URL。如需 OAuth 錯誤類型的清單，請參閱 Smartsheet API 文件中的 OAuth 錯誤類型。

  • 無法使用開發人員工具 – 確認您的 Smartsheet 帳戶已啟用開發人員工具。免費帳戶不支援開發人員工具。如果您的請求遭拒，請聯絡您的 Smartsheet Customer Success Manager。

  • API 金鑰身分驗證失敗 – 確認存取權杖尚未撤銷。您可以從 Smartsheet 應用程式中的個人設定 > API 存取管理權杖。如需詳細資訊，請參閱《 Smartsheet 說明中心》中的產生 API 存取字符。

  • 存取權杖已過期 – OAuth 存取權杖會在大約 7 天後過期。Amazon Quick 會自動處理字符重新整理。如果您遇到持久性字符錯誤，請登出並從整合設定再次登入。如需詳細資訊，請參閱 Smartsheet API 文件中的進行 API 呼叫。

常見錯誤訊息

  • 動作傳回許可錯誤 – 驗證已驗證的使用者在目標工作表上具有必要的共用許可。OAuth 範圍不會覆寫共用層級存取控制。如需詳細資訊，請參閱 Smartsheet API 文件中的資源存取層級。

  • 找不到工作表 – 驗證工作表 ID 是否正確，且已驗證的使用者至少具有工作表的檢視者存取權。

  • API 速率限制錯誤 – Smartsheet API 會強制執行速率限制。如需詳細資訊，請參閱 Smartsheet API 文件中的限制。