設定並使用 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 邀請人員加入團隊,包括外部協作者。團隊現有的邀請和網域設定仍適用於你邀請的人員。

我們可以再次取得現有邀請連結,而不必建立新邀請嗎?

可以。你可以使用受邀者的完整電子郵件地址取得現有邀請連結,不必產生新邀請。

這對你有幫助嗎?

有幫助

沒有幫助

其他人也看了