Motimate: Wie verwende ich die öffentliche API von Motimate?
Nutze die öffentliche API, um die Benutzerintegration und die Synchronisierung mit deiner Datenquelle zu automatisieren und Motimate mit anderen coolen Diensten zu verbinden 🔀.
Die öffentliche API v2 ist jetzt für alle Kunden verfügbar!
- Dokumentation für PAPI v1 (nur Legacy - alle neuen Kunden erhalten v2)
- Dokumentation für PAPI v2
Die öffentliche API ist eine Reihe von Diensten, mit denen du Daten in Motimate aktualisieren und verwalten kannst. Sie ist in einem Standard dokumentiert, der OpenAPI genannt wird, und bietet Entwicklern einen programmatischen Zugang zu unserer Software als Service. Diese API bietet eine breitere Unterstützung als SCIM und CSV, aber du brauchst einen Integrationsdienst oder einen Software-Roboter, um sie zu nutzen.
Die Einführung von PAPI v2 macht es einfacher als je zuvor, Daten aus deinem MotiSpace zu exportieren, mit Endpunkten wie:
Bitte beachte:
- Du musst deine API-Zugangsdaten beim Support anfordern, um diesen Dienst nutzen zu können.
- Die API-Datenbank wird in regelmäßigen Abständen ein paar Mal pro Stunde aktualisiert.
Datenmodelle
Die öffentliche API bietet Modelle zur Automatisierung der Benutzerbereitstellung und der Pulse-Beiträge. Es hat diese Datenmodelle:
-
Benutzermodell: Damit kannst du Informationen über Benutzerkonten lesen, schreiben und aktualisieren. Dies kann Kontaktinformationen, Zugriffsrollen und Gruppenzuweisungen für das Moti-Management beinhalten. Wenn ein Nutzer eine oder mehrere Positionen hat, kann dies ebenfalls in diesem Endpunkt festgelegt werden.
-
Gruppenmodell: Damit kannst du Benutzergruppen lesen, schreiben und zuweisen. Diese Gruppen können auch in einer Baumstruktur strukturiert werden, um sie an deine Organisation anzupassen und die Lernaufgaben zu vereinfachen.
Wichtig: Die Gruppenebene wird derzeit über das Attribut Art definiert. Der Wert von Art kann von Organisation zu Organisation unterschiedlich sein. Sie kann auch leicht von der Verwaltung deiner Organisation geändert werden. Wenn du die API-Integration einrichtest, ist es ratsam, eine dauerhafte Liste von Artnamen für deine Gruppenstufen zu definieren, um mögliche Fehler bei der API-Integration zu vermeiden, falls sich Artnamen ändern.
-
Positionsmodell: Mit diesem Modell kannst du Positionen lesen und schreiben, denen Benutzerkonten zugewiesen werden können.
-
Beiträge: Damit kannst du Beiträge erstellen und sie auf Pulse veröffentlichen. Dies kann in Kombination mit den Dateidiensten zum Hochladen von Bildern geschehen.
-
Dateien: Dieser Dienst wird verwendet, um Bilder für Pulse Posts hochzuladen. Die Größenbeschränkung für Bilder liegt bei 40 MB, für Videos bei 100 MB und für Dokumente bei 100 MB.
- Einblicke: Mit diesem Dienst kannst du einen Link zu einem individuellen Bericht erstellen und erhalten. Die Berichtsvorlage muss zuvor in der Motimate-Plattform mit der Funktion "Berichte generieren" unter "Einblicke" erstellt werden.
Authentifizierung
Der OAuth Token Endpunkt wird verwendet, um ein Access Token zu erstellen. Erhalte deine client_id und client_secret, indem du support@motimateapp.com kontaktierst .
Sobald du diese Angaben erhalten hast, können Token programmatisch oder über Plattformen wie Postman generiert werden. Alles, was du tun musst, ist, einen API-Aufruf an den POST /oauth/tokens Endpunktmit der client_id und den client_secret Anmeldeinformationen, die du vom Motimate Support erhalten hast, als JSON-Body.
Die API antwortet mit einem eindeutigen Token, der 24 Stunden lang gültig ist. Du kannst so viele Token erzeugen, wie du brauchst. Das Token sollte im Authorization-Header als Bearer-Token in deinen Anfragen an alle anderen Endpunkte übergeben werden ("Bearer "+[your_token]).
Beispiel:"Bearer eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
Du kannst den GET /me Endpunkt verwendet werden, um das Access Token zu überprüfen. Das ist nützlich, wenn du einen Keystore hast, in dem du dein Access Token aufbewahrst, und du überprüfen möchtest, ob es funktioniert, ohne irgendwelche Transaktionsaufrufe zu tätigen.
So testest du die API:
Um die API zu testen, empfehlen wir die Verwendung einer API-Plattform wie Postman. Eine Anleitung, wie du die vollständige Motimate-API-Dokumentation in Postman und Insomnia Collections importierst, findest du hier.
Du solltest dein API-Zugangs-Token wie oben beschrieben erstellen und dieses Token dann als Bearer-Token auf der Registerkarte Autorisierung in Postman eingeben. Dann kannst du die API testen und die Antworten überprüfen.
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.