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

Використовуйте публічний API, щоб автоматизувати інтеграцію користувачів та синхронізацію з вашим джерелом даних, а також підключайте Motimate до інших крутих сервісів 🔀.

Публічний API - це набір сервісів, які можна використовувати для оновлення та управління даними в Motimate. Він задокументований стандартним чином, називається OpenAPI і надає розробникам програмний доступ до нашого програмного забезпечення як до сервісу. Цей API має ширшу підтримку, ніж SCIM і CSV, але для його використання вам потрібен сервіс інтеграції або програмний робот.

Запуск PAPI v2 робить експорт даних з вашого MotiSpace простішим, ніж будь-коли, з такими кінцевими точками, як

• /motis/progresses
• /motis/chapter_completions
• /posts/ і
• /insights/learnings/report_requests

Моделі даних

Публічний API надає моделі для автоматизації налаштування користувачів та постів Pulse. Він має ці моделі даних:

• Модель користувача: Ви можете використовувати її для читання, запису та оновлення інформації про облікові записи користувачів. Це може включати контактну інформацію, ролі доступу та групові призначення для управління мотивами. Якщо користувач має одну або декілька позицій, це також можна встановити в цій кінцевій точці.
   
• Модель груп: Дозволяє читати, писати і призначати групи користувачів. Ці групи також можуть бути структуровані у вигляді дерева, щоб відповідати вашій організації та спростити навчальні завдання. 
  
  Важливо: Рівень групи наразі визначається за допомогою атрибута type. Значення виду може відрізнятися в різних організаціях. Він також може бути легко змінений адміністратором вашої організації. Під час налаштування API-інтеграції рекомендується визначити постійний список назв видів для рівнів ваших груп, щоб уникнути потенційних помилок в API-інтеграції в разі зміни назв видів.
   
• Модель посад: Ця модель дозволяє читати і записувати посади, на які можуть бути призначені облікові записи користувачів.
   
• Дописи: Ви можете використовувати цей розділ для створення дописів і публікації їх на Пульсі. Це можна зробити в поєднанні з файловими сервісами для завантаження зображень.
   
• Файли: Цей сервіс використовується для завантаження зображень для імпульсних дописів. Обмеження на розмір зображень - 40 МБ, відео - 100 МБ, документів - 100 МБ.
   
• Інсайти: Ця послуга використовується для створення та отримання посилання на персоналізований звіт. Шаблон звіту має бути створений заздалегідь на платформі Motimate за допомогою функції "Створювати звіти" в розділі "Інсайти".

Аутентифікація

Кінцева точка OAuth Token використовується для створення токену доступу. Отримайте свій client_id та client_secret, звернувшись за адресою support@motimateapp.com.

Отримавши ці дані, токени можна згенерувати програмно або за допомогою таких платформ, як Postman. Все, що вам потрібно зробити, це відправити виклик API на адресу POST /oauth/tokensз ідентифікатором клієнта client_id та обліковими даними client_secret, які ви отримали від служби підтримки Motimate у вигляді JSON-тексту.

API відповість унікальним токеном, який буде дійсним протягом 24 годин. Ви можете згенерувати стільки токенів, скільки вам потрібно. Токен повинен передаватися в заголовок авторизації як токен пред'явника в ваших запитах до всіх інших кінцевих точок ("пред'явник "+[ваш_токен]).

Приклад:
"Пред'явник eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
 

Ви можете використовувати GET /me endpoint використовується для перевірки токена доступу. Це корисно, якщо у вас є сховище ключів для зберігання токенів доступу, і ви хочете перевірити його працездатність, не викликаючи жодних транзакційних викликів.