Canva 首頁
說明

設定並使用 Canva 管理員 API


本文係由機器翻譯而成。如發現錯誤,請告知我們。

注意:Canva 中需要有組織才能使用管理員 API。管理員 API 適用於組織層級。

你可以使用 Canva 管理員 API,透過自己的系統自動化管理組織。管理使用者、團隊、群組和成員資格,並擷取稽核日誌事件,無需在 Canva 手動完成這些工作。

查看是否適用

  • 適用於 Canva Enterprise、Canva Districts 和 Canva 校園版。
  • 組織管理員可以使用。
  • 適用於單一團隊和多團隊組織。

查看使用要求

設定管理員 API 前,請確認你的組織符合以下要求:

  • 組織層級: 管理員 API 的範圍是組織。Canva Enterprise、Canva Districts 和 Canva 校園版方案中的單一團隊及多團隊組織均可使用。
  • 組織管理員帳戶: 只有組織管理員可以在 Canva 設定中建立及管理管理員 API 用戶端。
  • 內部或外判工程支援:你的組織需要具備工程資源,以建置及維護整合功能。Canva 不提供實作支援。
    • 如果你的團隊無法透過 API 建置整合功能,SCIM 佈建 會更適合用來自動化管理組織中的使用者。
  • 熟悉 Canva 組織架構:建置整合功能前,請先清楚了解組織、團隊及群組在 Canva 中的設定方式。
  • 多重驗證 (MFA) 或透過單一登入 (SSO) 管理的帳戶: 設定管理員 API 的組織管理員必須啟用 MFA,或使用由 SSO 管理的帳戶。該帳戶必須由其代表的組織管理或擁有。

了解可管理的項目

管理員 API 提供以下端點:

  • 使用者、團隊和群組:建立、讀取、更新及刪除。
  • 成員資格:新增或移除團隊和群組成員,並設定其角色。
  • 稽核日誌:按排程擷取稽核日誌事件。
  • 團隊邀請:邀請他人加入團隊(包括組織以外的人士)、檢視待處理的邀請、透過完全相符的電郵地址擷取現有邀請連結,以及取消邀請。

設定管理員 API

組織管理員會建立管理員 API 用戶端,並使用它呼叫 API。

設定管理員 API

  1. 前往
    「設定」。
  2. 選取「管理員 API」,然後選取「建立 API 用戶端」。
  3. 為用戶端命名並選取定義用戶端可存取內容的範圍。
  4. 選取「繼續」。
  5. 複製用戶端 ID 和用戶端密鑰,然後選取「完成」。
  6. 交換憑證以取得存取憑證,該憑證在四小時內有效。
  7. 使用存取憑證呼叫管理員 API。

請按照 Canva 管理員 API 文件的說明,將用戶端憑證換取存取憑證,然後開始發出 API 要求。

如需了解驗證 API 要求及使用 OAuth 2.0 bearer 憑證的技術詳情,請將 Canva 管理員 API 驗證文件分享給工程團隊。

了解管理員 API 稽核日誌

透過管理員 API 執行的操作會記錄在管理員 API 用戶端名下,而非呼叫該用戶端的個別管理員名下。

在稽核日誌中,「執行者」欄位會顯示管理員 API 用戶端名稱和用戶端 ID,讓你識別是哪個整合功能執行了操作。

你亦可以識別建立、更新或刪除特定 API 用戶端的組織管理員。

如需更多資訊,請參閱關於 Canva 稽核日誌。

邀請他人加入團隊

組織管理員可以使用管理員 API 邀請他人加入團隊,包括組織以外的外部協作者。

須知事項

  • 每個邀請只適用於一個團隊和一個電郵地址。
  • 每個邀請只能使用一次,並會在30 天後失效。
  • 視乎你的設定,Canva 未必會自動向受邀者發送電郵。如有需要,請直接將邀請連結分享給受邀者。
  • 請妥善保管邀請連結。邀請連結只適用於建立邀請時使用的電郵地址。
  • 你團隊現有的邀請和網域設定仍適用於受邀者。
  • 如果受邀者已有待處理的邀請,建立新邀請時會傳回相同的邀請記錄;有效期會由收到要求當日起重設為 30 天,而邀請角色則會更新為要求指定的角色。

如需了解端點詳情,請參閱Canva 管理員 API 文件。

選擇管理員 API 或 SCIM

管理員 API 和 SCIM 均可用於支援使用者佈建。

管理員 API 除了支援使用者佈建,亦支援管理 Canva 組織,包括團隊、群組、成員資格和稽核日誌。

SCIM 支援標準佈建和取消佈建。如果你只需要標準使用者佈建,或團隊無法建置自訂 API 整合功能,SCIM 會更符合你的需要。

常見問題

我的組織需要聘請開發人員才能使用管理員 API 嗎?

需要。你的組織必須具備內部或外判工程資源,以建置及維護整合功能。Canva 不提供實作支援。如果你的團隊無法透過 API 建置整合功能,SCIM 佈建會更適合用來自動化管理組織中的使用者。

組織內的所有人都需要使用 MFA 或 SSO,才能使用管理員 API 嗎?

不需要。只有設定管理員 API 的組織管理員必須啟用 MFA,或使用由 SSO 管理的帳戶。該帳戶必須由其代表的組織管理或擁有。組織內其他成員無需特別使用 MFA 或 SSO,管理員 API 才能運作。

我的組織可以使用管理員 API 邀請外部協作者嗎?

可以。組織管理員可以使用管理員 API 邀請他人加入團隊,包括外部協作者。你團隊現有的邀請和網域設定仍適用於受邀者。

我們可以再次擷取現有邀請連結,而無需建立新邀請嗎?

可以。你可以使用受邀者完全相符的電郵地址擷取現有邀請連結,無需建立新邀請。

這對你有幫助嗎?

有幫助

沒有幫助

其他人也看了