Motimate: Wie verwende ich die öffentliche API zur Bereitstellung und Verwaltung von Benutzern und Gruppen?

Du kannst Benutzer in Motimate bereitstellen und verwalten, indem du dein Quellsystem mit unserer REST-API verbindest. Damit kannst du verschiedene Kernaufgaben in Motimate erledigen, z. B. Benutzer erstellen, aktualisieren, löschen, Gruppen erstellen und Benutzer den richtigen Gruppen zuweisen. 

Hintergrundinformationen: 

• Alle Benutzer/innen und Gruppen haben ihre eigenen Motimate-IDs, die mit der API verwendet werden können, aber du kannst auch eine "externe ID" definieren, die du mit der API verwenden kannst. Diese "externe ID" wird normalerweise so eingestellt, dass sie mit der ID übereinstimmt, die du für diesen Benutzer oder diese Gruppe in deiner eigenen Datenquelle hast. 
   
• Gruppen werden verwendet, um eine Hierarchie oder einen Gruppenbaum zu erstellen. Dieser spiegelt in der Regel die Struktur deiner Organisation wider und wird verwendet, um Schulungen zu delegieren und Berichte zu erhalten. Diese sind oft entweder nach Abteilungen und Teams oder nach Regionen gegliedert. Wir empfehlen, Gruppen zu erstellen, bevor du Benutzer anlegst, damit du die Benutzer direkt bei der Erstellung den Gruppen zuweisen kannst. Hier findest du weitere Informationen zur Gruppenstruktur.
   
• Die Position eines Nutzers ermöglicht es dir, Schulungen auf der Grundlage seiner Rolle im Unternehmen zu delegieren. Hier findest du weitere Informationen zu den Nutzerpositionen.
   
• Wir empfehlen, eine Testumgebung einzurichten, um deine Aufrufe und die Integration insgesamt zu testen, bevor du sie in deine Produktionsumgebung überträgst. Bitte kontaktiere deinen Customer Success Manager oder support@motimateapp.com , um Hilfe zu erhalten. 
   
• Die API von Motimate ist im JSON-Format. 

Gruppen erstellen

Um Gruppen zu erstellen, verwende den folgenden Aufruf:
POST https://motimateapp.com/public_api/groups

Füge den Payload mit den notwendigen Informationen der Gruppe zum Body hinzu. Das Feld "parent_id" wird verwendet, um eine Gruppenstruktur zu erstellen. Wenn du die ID einer anderen Gruppe in dieses Feld einträgst, wird diese Gruppe als übergeordnete Gruppe festgelegt.

Bitte beachte: Die Ebene der Gruppe muss in der Hierarchie niedriger sein als die übergeordnete Gruppe, wobei "Ebene 1" die höchste Ebene ist. Damit kannst du Gruppenstrukturen in dein Motimate-Konto importieren. 

Gruppen aktualisieren 

Um eine Gruppe in Motimate zu aktualisieren, brauchst du den folgenden Aufruf. Die in diesem Beispiel verwendete ID ist die Motimate-Gruppen-ID. 

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

Füge dem Body die Nutzdaten hinzu, die du in den Gruppen aktualisieren möchtest. Dies kann verwendet werden, wenn eine Gruppe auf eine andere Ebene verschoben oder die Struktur angepasst werden muss. 

 

Löschen von Gruppen

Um eine Gruppe in Motimate zu löschen, brauchst du den folgenden Aufruf. Die in diesem Beispiel verwendete ID ist die Motimate-Gruppen-ID. Wenn du force auf '1' setzt, wird der Datensatz zerstört. In diesem Fall gibt es keine Möglichkeit, die Gruppe wiederherzustellen.

LÖSCHEN https://motimateapp.com/public_api/groups/{group_id}

Wenn du diesen Aufruf ausführst, wird die ausgewählte Gruppe gelöscht, obwohl keine Antwort zurückgegeben wird:

 

Benutzer erstellen

Um Benutzer anzulegen, verwende den folgenden Aufruf: 

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

Füge den Payload mit den notwendigen Informationen des Nutzers zum Body hinzu. Je nach den Einstellungen deines Motimate-Kontos ist entweder die E-Mail-Adresse oder die Telefonnummer ein Pflichtfeld. Du kannst die Gruppen des Benutzers über das Feld Gruppenzuweisungen auswählen. Gib die Gruppennummer ein, der der Benutzer angehören soll, und seine Rolle in der Gruppe (Mitglied, Administrator oder Beobachter). Wir empfehlen, assing_ancestors in den allermeisten Fällen auf "true" zu setzen. Dadurch wird sichergestellt, dass die Benutzer/innen Mitglieder der übergeordneten Gruppen der ihnen zugewiesenen Gruppen sind. 

 

Benutzer aktualisieren

Um die Informationen eines Benutzers in Motimate zu aktualisieren, brauchst du den folgenden Aufruf. Die in diesem Beispiel verwendete ID ist die Motimate-Benutzerkennung. 

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

Füge dem Body die Nutzdaten hinzu, die du für den Nutzer aktualisieren möchtest.

 

Benutzer löschen

Um einen Benutzer in Motimate zu löschen, brauchst du den folgenden Aufruf. Die in diesem Beispiel verwendete ID ist die Motimate-Benutzerkennung. Wenn du force auf '1' setzt, wird der Datensatz zerstört. In diesem Fall gibt es keine Möglichkeit, die Gruppe wiederherzustellen. Wenn du den Wert auf "0" setzt, wird der Datensatz sanft gelöscht, sodass er bei Bedarf wiederhergestellt werden kann. 

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

Wenn du diesen Aufruf ausführst, wird der ausgewählte Benutzer gelöscht, obwohl keine Antwort zurückgegeben wird: 

Benutzer wiederherstellen

Manchmal wird ein Benutzer versehentlich gelöscht und muss wiederhergestellt werden. Wenn sie weich gelöscht und nicht hart zerstört wurden, kann dies mit dem folgenden Aufruf geschehen. Die in diesem Beispiel verwendete ID ist die Motimate-Benutzerkennung. 

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