Motimate : Comment utiliser l'API publique pour provisionner et gérer les utilisateurs et les groupes ?

Vous pouvez provisionner et gérer les utilisateurs dans Motimate en connectant votre système source à notre API REST. Cela vous permet de gérer plusieurs tâches essentielles dans Motimate, telles que la création d'utilisateurs, la mise à jour d'utilisateurs, la suppression d'utilisateurs, la création de groupes et l'affectation d'utilisateurs aux groupes appropriés. 

Informations générales : 

• Tous les utilisateurs et groupes ont un identifiant Motimate unique qui peut être utilisé avec l'API, mais vous pouvez également définir un "identifiant externe" que vous pouvez utiliser avec l'API. Cet "identifiant externe" est généralement défini de manière à correspondre à l'identifiant que vous avez pour cet utilisateur ou ce groupe dans votre propre source de données. 
   
• Les groupes sont utilisés pour créer une hiérarchie ou une arborescence. Il reflète généralement la structure de votre organisation et sert à déléguer la formation et à obtenir des rapports. Elle est souvent basée sur les départements et les équipes, ou sur les régions. Il est recommandé de créer des groupes avant de créer des utilisateurs afin de pouvoir affecter les utilisateurs directement aux groupes lors de la création. Voir ici pour plus d'informations sur la structure du groupe.
   
• La position d'un utilisateur vous permet de déléguer la formation en fonction de son rôle au sein de l'organisation. Voir ici pour plus d'informations sur les postes d'utilisateurs.
   
• Nous vous recommandons de mettre en place un environnement de test pour tester vos appels et l'intégration dans son ensemble, avant de le transférer dans votre environnement de production. Veuillez contacter votre Customer Success Manager ou support@motimateapp.com pour obtenir de l'aide. 
   
• L'API de Motimate est au format JSON. 

Création de groupes

Pour créer des groupes, utilisez l'appel suivant :
POST https://motimateapp.com/public_api/groups

Ajoutez la charge utile au corps du message avec les informations nécessaires sur le groupe. Le champ "parent_id" est utilisé pour créer une structure de groupe. En saisissant l'ID d'un autre groupe dans ce champ, ce groupe sera considéré comme le parent.

Remarque: le niveau du groupe doit se situer dans la hiérarchie inférieure à celle du groupe parent, le "niveau 1" étant le niveau le plus élevé. Cela vous permet d'importer des structures de groupe dans votre compte Motimate. 

Mise à jour des groupes 

Pour mettre à jour un groupe dans Motimate, vous aurez besoin de l'appel suivant. L'identifiant utilisé dans cet exemple est l'identifiant du groupe Motimate. 

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

Ajoutez au corps du message les données nécessaires que vous souhaitez mettre à jour dans les groupes. Cela peut être utilisé lorsqu'un groupe doit être déplacé à un niveau différent ou si la structure doit être ajustée. 

 

Suppression de groupes

Pour supprimer un groupe dans Motimate, vous aurez besoin de l'appel suivant. L'identifiant utilisé dans cet exemple est l'identifiant du groupe Motimate. Le réglage de la force sur "1" détruira définitivement l'enregistrement, il n'y a aucun moyen de récupérer le groupe dans ce scénario.

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

L'exécution de cet appel supprimera le groupe sélectionné, bien qu'aucune réponse ne soit renvoyée :

 

Création d'utilisateurs

Pour créer des utilisateurs, utilisez l'appel suivant : 

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

Ajouter la charge utile au corps du message avec les informations nécessaires sur l'utilisateur. L'adresse électronique ou le numéro de téléphone est un champ obligatoire, selon les paramètres de votre compte Motimate. Vous pouvez sélectionner les groupes de l'utilisateur en utilisant le champ des affectations de groupe. Saisissez l'identifiant du groupe dont l'utilisateur doit faire partie et son rôle dans le groupe (membre, administrateur ou observateur). Nous recommandons d'attribuer la valeur "true" à assing_ancestors dans la grande majorité des cas. Cela garantit que les utilisateurs seront membres des groupes parents des groupes qui leur ont été attribués. 

 

Mise à jour des utilisateurs

Pour mettre à jour les informations d'un utilisateur dans Motimate, vous aurez besoin de l'appel suivant. L'identifiant utilisé dans cet exemple est l'identifiant de l'utilisateur Motimate. 

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

Ajoutez une charge utile au corps du message avec les seules données nécessaires que vous souhaitez mettre à jour pour l'utilisateur.

 

Suppression d'utilisateurs

Pour supprimer un utilisateur dans Motimate, vous aurez besoin de l'appel suivant. L'identifiant utilisé dans cet exemple est l'identifiant de l'utilisateur Motimate. Le réglage de la force sur "1" détruira définitivement l'enregistrement, il n'y a aucun moyen de récupérer le groupe dans ce scénario. La valeur "0" efface l'enregistrement, ce qui permet de le récupérer si nécessaire. 

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

L'exécution de cet appel entraîne la suppression de l'utilisateur sélectionné, bien qu'aucune réponse ne soit renvoyée : 

Restauration des utilisateurs

Il arrive qu'un utilisateur soit supprimé par erreur et qu'il faille le restaurer. S'ils ont été supprimés à l'amiable, et non pas détruits en dur, il est possible de le faire avec l'appel suivant. L'identifiant utilisé dans cet exemple est l'identifiant de l'utilisateur Motimate. 

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