Motimate: Jak korzystać z Motimate Public API?

Użyj publicznego interfejsu API, aby zautomatyzować integrację użytkowników i synchronizację ze źródłem danych oraz połączyć Motimate z innymi fajnymi usługami 🔀

Publiczne API to zestaw usług, które mogą być używane do aktualizacji i zarządzania danymi w Motimate. Jest on udokumentowany w standardowy sposób, zwany OpenAPI, i zapewnia programistom programowy dostęp do naszego oprogramowania jako usługi. Ten interfejs API ma szerszą obsługę niż to, co można zrobić za pomocą SCIM i CSV, ale potrzebujesz usługi integracji lub robota programowego, aby z niego korzystać.

Uruchomienie PAPI v2 sprawia, że eksport danych z Twojej MotiSpace jest łatwiejszy niż kiedykolwiek wcześniej, dzięki takim punktom końcowym jak:

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

Modele danych

Publiczny interfejs API zapewnia modele do automatyzacji udostępniania użytkowników i postów Pulse. Posiada następujące modele danych:

• Model użytkownika: Możesz go użyć do odczytu, zapisu i aktualizacji informacji o kontach użytkowników. Może to obejmować informacje kontaktowe, role dostępu i przypisania do grup w celu zarządzania motywami. Jeśli użytkownik ma jedną lub wiele pozycji, można to również ustawić w tym punkcie końcowym.
   
• Model grup: Umożliwia odczyt, zapis i przypisywanie grup użytkowników. Grupy te mogą być również zorganizowane w strukturę drzewa, aby dopasować się do Twojej organizacji i uprościć zadania edukacyjne. 
  
  Ważne: Poziom grupy jest obecnie definiowany przy użyciu atrybutu rodzaj. Wartość rodzaju może się różnić w zależności od organizacji. Może on również zostać łatwo zmieniony przez administratora Twojej organizacji. Podczas konfigurowania integracji API zaleca się zdefiniowanie stałej listy nazw rodzajów dla poziomów grup, aby uniknąć potencjalnych błędów w integracji API w przypadku zmiany nazw rodzajów.
   
• Model pozycji: Ten model umożliwia odczyt i zapis pozycji, do których można przypisać konta użytkowników.
   
• Posty: Możesz użyć tej opcji do tworzenia postów i publikowania ich w Pulse. Można to zrobić w połączeniu z usługami plików, aby przesyłać obrazy.
   
• Pliki: Ta usługa służy do przesyłania obrazów do postów Pulse. Limit rozmiaru zdjęć wynosi 40 MB, filmów 100 MB, a dokumentów 100 MB.
   
• Spostrzeżenia: Ta usługa służy do generowania i uzyskiwania łącza do niestandardowego raportu. Szablon raportu musi zostać wcześniej utworzony na platformie Motimate za pomocą funkcji "Generuj raporty" w sekcji "Statystyki".

Uwierzytelnianie

Punkt końcowy tokenu OAuth służy do tworzenia tokenu dostępu. Uzyskaj swój client_id i client_secret, kontaktując się z support@motimateapp.com.

Po otrzymaniu tych danych tokeny mogą być generowane programowo lub za pośrednictwem platform takich jak Postman. Wszystko, co musisz zrobić, to wysłać wywołanie API do punktu końcowego POST /oauth/tokens endpointwraz z client_id i poświadczeniami client_secret, które otrzymałeś od Motimate Support jako treść JSON.

API odpowie unikalnym tokenem, który będzie ważny przez 24 godziny. Możesz wygenerować tyle tokenów, ile potrzebujesz. Token powinien być przekazywany do nagłówka Authorization jako token Bearer w żądaniach do wszystkich innych punktów końcowych ("Bearer "+[your_token]).

Przykład:
"Bearer eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
 

Możesz użyć Punkt końcowy GET /me służy do weryfikacji tokena dostępu. Jest to przydatne, jeśli masz magazyn kluczy do przechowywania tokena dostępu i chcesz sprawdzić, czy działa on bez wywoływania jakichkolwiek wywołań transakcyjnych.