Motimate：如何使用公共 API 來提供和管理使用者與群組？

Screenshot 2025-03-11 at 17.37.47 copy.png

您可以透過連接您的來源系統與我們的 REST API，在 Motimate 中配置和管理使用者。這可讓您在 Motimate 中處理幾個核心工作，例如建立使用者、更新使用者、刪除使用者、建立群組以及將使用者配置到正確的群組。

有關 Motimate Public API 的一般資訊以及如何開始使用、 請參閱這裡.

背景資料：

所有使用者和群組都有其獨特的 Motimate ID，可以在 API 中使用，但您也可以定義一個「外部 ID」，可以在 API 中使用。這個「外部 ID」通常設定為與您自己資料來源中該使用者或群組的 ID 相匹配。
群組可用於建立層級結構或群組樹狀結構。這通常會密切反映您的組織結構，並用於委派訓練和取得報告。這通常以部門和團隊或區域為基礎。我們建議在建立使用者之前先建立群組，這樣您就可以在建立群組時直接將使用者指派給群組。請參閱此處以取得更多關於群組結構的資訊。
使用者的職位可讓您根據他們在組織中的角色來委派訓練。有關使用者職位的詳細資訊，請參閱此處。
我們建議您在轉移到生產環境之前，先建立一個測試環境來測試您的呼叫和整體整合。請聯絡您的客戶成功經理或support@motimateapp.com 以取得協助。
Motimate 的 API 採用 JSON 格式。

建立群組

要建立群組，請使用下列呼叫：
POST https://motimateapp.com/public_api/groups

在正文中加入包含必要資訊的 payload 與群組。 parent_id "欄位用來建立群組結構。在此欄位中輸入不同群組的 ID 將設定該群組為父群組。

請注意：群組的層級必須比父群組的層級低，「層級 1」為最高層級。這可讓您將群組結構匯入您的 Motimate 帳戶。

更新群組

為了在 Motimate 中更新群組，您需要下列呼叫。本範例中使用的 id 是 Motimate 群組 id。

PATCH https://motimateapp.com/public_api/groups/{group_id}

在正文中加入 payload，其中包含您希望在 Groups 上更新的必要資料。當需要將群組移到不同的層級，或需要調整結構時，可以使用此功能。

刪除群組

要在 Motimate 中刪除群組，您需要以下呼叫。本範例中使用的 id 是 Motimate 群組 id。將強制力設定為´1´會硬銷毀記錄，在此情況下無法恢復群組。

刪除 https://motimateapp.com/public_api/groups/{group_id}

執行此呼叫會刪除選取的群組，但不會傳回回應：

建立使用者

若要建立使用者，請使用下列呼叫：

發佈 https://motimateapp.com/public_api/users

在正文中加入包含使用者必要資訊的 payload。根據您的 Motimate 帳戶設定，電子郵件地址或電話號碼都是必填欄位。您可以使用群組指派欄位選擇使用者的群組。輸入您希望使用者加入的群組 ID 及其在群組中的角色 (成員、管理員或觀察員)。我們建議在絕大多數的情況下，將 assing_ancestors 設為「true」。這可確保使用者將成為其指定群組的父群組的成員。