Motimate: Jak używać publicznego API do udostępniania i zarządzania użytkownikami i grupami?

Możesz udostępniać użytkowników i zarządzać nimi w Motimate, łącząc swój system źródłowy z naszym interfejsem API REST. Umożliwia to obsługę kilku podstawowych zadań w Motimate, takich jak tworzenie użytkowników, aktualizowanie użytkowników, usuwanie użytkowników, tworzenie grup i przydzielanie użytkowników do odpowiednich grup. 

Informacje ogólne: 

• Wszyscy użytkownicy i grupy mają swoje unikalne identyfikatory Motimate ID, które mogą być używane z API, ale możesz także zdefiniować "zewnętrzny identyfikator", którego możesz używać z API. Ten "zewnętrzny identyfikator" jest zwykle ustawiony tak, aby pasował do identyfikatora, który masz dla tego użytkownika lub grupy we własnym źródle danych. 
   
• Grupy są używane do tworzenia hierarchii lub drzewa grup. Zwykle będzie to ściśle odzwierciedlać strukturę twojej organizacji i służy do delegowania szkoleń i uzyskiwania raportów. Często opiera się to na działach i zespołach lub regionach. Zalecamy utworzenie grup przed utworzeniem użytkowników, abyś mógł przypisać użytkowników bezpośrednio do grup po ich utworzeniu. Więcej informacji na temat struktury grupy znajdziesz tutaj.
   
• Pozycja użytkownika pozwala na delegowanie szkoleń w oparciu o jego rolę w organizacji. Więcej informacji na temat stanowisk użytkowników znajdziesz tutaj.
   
• Zalecamy skonfigurowanie środowiska testowego do testowania połączeń i integracji jako całości, przed przeniesieniem do środowiska produkcyjnego. Skontaktuj się ze swoim Customer Success Managerem lub support@motimateapp.com , aby uzyskać pomoc. 
   
• Interfejs API Motimate jest w formacie JSON. 

Tworzenie grup

Aby utworzyć grupy, użyj następującego wywołania:
POST https://motimateapp.com/public_api/groups

Dodaj ładunek do treści z niezbędnymi informacjami wraz z grupą. Pole "parent_id" służy do tworzenia struktury grupy. Wprowadzenie identyfikatora innej grupy w tym polu spowoduje ustawienie tej grupy jako nadrzędnej.

Uwaga: poziom grupy musi znajdować się w niższej hierarchii niż grupa nadrzędna, przy czym "Poziom 1" jest najwyższym poziomem. Dzięki temu możesz importować struktury grup do swojego konta Motimate. 

Aktualizacja grup 

Aby zaktualizować grupę w Motimate, będziesz potrzebować następującego połączenia. Identyfikator użyty w tym przykładzie to identyfikator grupy Motimate. 

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

Dodaj ładunek do treści z niezbędnymi danymi, które chcesz zaktualizować w grupach. Może to być używane, gdy grupa musi zostać przeniesiona na inny poziom lub gdy struktura wymaga dostosowania. 

 

Usuwanie grup

Aby usunąć grupę w Motimate, będziesz potrzebować następującego połączenia. Identyfikator użyty w tym przykładzie to identyfikator grupy Motimate. Ustawienie siły na "1" spowoduje twarde zniszczenie rekordu, nie ma możliwości odzyskania grupy w tym scenariuszu.

USUŃ https://motimateapp.com/public_api/groups/{group_id}

Uruchomienie tego wywołania spowoduje usunięcie wybranej grupy, choć odpowiedź nie zostanie zwrócona:

 

Tworzenie użytkowników

Aby utworzyć użytkowników, użyj następującego wywołania: 

POST https://motimateapp.com/public_api/users

Dodaj ładunek do treści z niezbędnymi informacjami o użytkowniku. Adres e-mail lub numer telefonu będzie polem obowiązkowym w zależności od ustawień Twojego konta Motimate. Możesz wybrać grupy użytkownika, korzystając z pola przypisań grupowych. Wprowadź identyfikator grupy, do której ma należeć użytkownik oraz jego rolę w grupie (członek, administrator lub obserwator). Zalecamy ustawienie assing_ancestors na "true" w zdecydowanej większości scenariuszy. Gwarantuje to, że użytkownicy będą członkami grup nadrzędnych przypisanych im grup. 

 

Aktualizacja użytkowników

Aby zaktualizować informacje o użytkowniku w Motimate, będziesz potrzebować następującego połączenia. Identyfikator użyty w tym przykładzie to identyfikator użytkownika Motimate. 

PATCH https://motimateapp.com/public_api/users/{user_id}?identifier_type=id

Dodaj ładunek do treści z jedynymi niezbędnymi danymi, które chcesz zaktualizować dla użytkownika.

 

Usuwanie użytkowników

Aby usunąć użytkownika w Motimate, będziesz potrzebować następującego połączenia. Identyfikator użyty w tym przykładzie to identyfikator użytkownika Motimate. Ustawienie siły na "1" spowoduje twarde zniszczenie rekordu, nie ma możliwości odzyskania grupy w tym scenariuszu. Ustawienie wartości "0" spowoduje miękkie usunięcie rekordu, umożliwiając jego odzyskanie w razie potrzeby. 

DELETE https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id

Uruchomienie tego wywołania spowoduje usunięcie wybranego użytkownika, chociaż odpowiedź nie zostanie zwrócona: 

Przywracanie użytkowników

Czasami użytkownik zostaje usunięty przez pomyłkę i musi zostać przywrócony. Jeśli zostały one miękko usunięte, a nie twardo zniszczone, można to zrobić za pomocą następującego wywołania. Identyfikator użyty w tym przykładzie to identyfikator użytkownika Motimate. 

PATCH https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id