Motimate: Як використовувати публічний API для створення та управління користувачами та групами?

Ви можете надавати користувачів і керувати ними в Motimate, підключивши вашу вихідну систему до нашого REST API. Це дозволяє вам виконувати кілька основних завдань у Motimate, таких як створення користувачів, оновлення користувачів, видалення користувачів, створення груп і призначення користувачів до потрібних груп. 

Довідкова інформація: 

• Всі користувачі та групи мають свої унікальні ідентифікатори Motimate ID, які можна використовувати з API, але ви також можете визначити "зовнішній ідентифікатор", який також можна використовувати з API. Цей "зовнішній ідентифікатор" зазвичай встановлюється відповідно до ідентифікатора, який ви маєте для цього користувача або групи у вашому власному джерелі даних. 
   
• Групи використовуються для створення ієрархії або дерева груп. Зазвичай вона точно відображає структуру вашої організації і використовується для делегування тренінгів та отримання звітів. Це часто базується або на відділах і командах, або на регіонах. Ми рекомендуємо створювати групи перед створенням користувачів, щоб ви могли призначати користувачів безпосередньо до груп після їх створення. Більше інформації про структуру групи дивіться тут.
   
• Посада користувача дозволяє вам делегувати навчання на основі його ролі в організації. Дивіться тут для отримання додаткової інформації про посади користувачів.
   
• Ми рекомендуємо створити тестове середовище, щоб протестувати ваші дзвінки та інтеграцію в цілому, перш ніж переходити до виробничого середовища. Зверніться за допомогою до вашого менеджера з обслуговування клієнтів або на електронну адресу support@motimateapp.com . 
   
• API Motimate має формат JSON. 

Створення груп

Для створення груп використовуйте наступний виклик:
POST https://motimateapp.com/public_api/groups

Додайте корисний вантаж до тіла з необхідною інформацією разом з групою. Поле "parent_id" використовується для створення структури групи. Введення ідентифікатора іншої групи в це поле зробить цю групу батьківською.

Зверніть увагу: рівень групи повинен бути нижчим в ієрархії, ніж рівень батьківської групи, причому "Рівень 1" є найвищим рівнем. Це дозволяє імпортувати структури груп до вашого облікового запису Motimate. 

Оновлення груп 

Щоб оновити групу в Motimate, вам знадобиться наступний виклик. У цьому прикладі використовується ідентифікатор групи Motimate. 

ЛЯПОЧКА https://motimateapp.com/public_api/groups/{group_id}

Додайте до тіла корисне навантаження з необхідними даними, які ви хочете оновити в групах. Це може бути використано, коли групу потрібно перевести на інший рівень або скоригувати структуру. 

 

Видалення груп

Щоб видалити групу в Motimate, вам знадобиться наступний виклик. У цьому прикладі використовується ідентифікатор групи Motimate. Встановлення сили у ´1´ призведе до повного знищення запису, відновити групу у цьому сценарії неможливо.

ВИДАЛИТИ https://motimateapp.com/public_api/groups/{group_id}

Запуск цього виклику видалить вибрану групу, хоча відповідь не повертається:

 

Створення користувачів

Щоб створити користувачів, скористайтеся наступним викликом: 

ПОСТ https://motimateapp.com/public_api/users

Додайте до тіла корисне навантаження з необхідною інформацією про користувача. Адреса електронної пошти або номер телефону будуть обов'язковими полями, залежно від налаштувань вашого облікового запису Motimate. Ви можете вибрати групи користувача за допомогою поля групових призначень. Введіть ідентифікатор групи, до якої ви хочете приєднати користувача, та його роль у групі (учасник, адміністратор або спостерігач). Ми рекомендуємо встановити assing_ancestors у значення "true" у переважній більшості сценаріїв. Це гарантує, що користувачі будуть членами батьківських груп призначених їм груп. 

 

Оновлення користувачів

Щоб оновити інформацію про користувача в Motimate, вам знадобиться наступний виклик. У цьому прикладі використовується ідентифікатор користувача Motimate. 

ВИПРАВЛЕННЯ https://motimateapp.com/public_api/users/{user_id}?identifier_type=id

Додайте корисне навантаження до тіла з тільки необхідними даними, які ви хочете оновити для користувача.

 

Видалення користувачів

Щоб видалити користувача в Motimate, вам знадобиться наступний виклик. У цьому прикладі використовується ідентифікатор користувача Motimate. Встановлення сили у ´1´ призведе до повного знищення запису, відновити групу у цьому сценарії неможливо. Якщо встановити значення ´0´, запис буде м'яко видалено, але його можна буде відновити, якщо це необхідно. 

ВИДАЛИТИ https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id

Запуск цього виклику видалить вибраного користувача, хоча відповідь не повертається: 

Відновлення користувачів

Іноді користувача видаляють помилково, і його потрібно відновити. Якщо вони були видалені м'яко, а не жорстко, це можна зробити за допомогою наступного виклику. У цьому прикладі використовується ідентифікатор користувача Motimate. 

ВИПРАВЛЕННЯ https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id