Motimate: ¿Cómo utilizar la API pública para aprovisionar y gestionar usuarios y grupos?

Puedes aprovisionar y gestionar usuarios en Motimate conectando tu sistema fuente a nuestra API REST. Esto te permite manejar varias tareas básicas en Motimate como crear usuarios, actualizar usuarios, borrar usuarios, crear grupos y aprovisionar usuarios a los grupos correctos. 

Información general: 

• Todos los usuarios y grupos tienen su ID único de Motimate que se puede utilizar con la API, pero también puedes definir un "ID externo" que puedes utilizar con la API. Este "ID externo" suele configurarse para que coincida con el ID que tienes para ese usuario o grupo en tu propia fuente de datos. 
   
• Los grupos se utilizan para crear una jerarquía o árbol de grupos. Suele reflejar fielmente la estructura de tu organización, y se utiliza para delegar la formación y obtener informes. Suele basarse en departamentos y equipos, o en regiones. Te recomendamos que crees los grupos antes de crear los usuarios, para que puedas asignarlos directamente a los grupos en el momento de su creación. Consulta aquí más información sobre la estructura de los grupos.
   
• La Posición de un usuario te permite delegar la formación en función de su función en la organización. Consulta aquí más información sobre los Puestos de usuario.
   
• Te recomendamos que configures un entorno de prueba para comprobar tus llamadas y la integración en su conjunto, antes de transferirlas a tu entorno de producción. Ponte en contacto con tu Gestor de Éxito de Clientes o con support@motimateapp.com para obtener ayuda. 
   
• La API de Motimate está en formato JSON. 

Crear grupos

Para crear grupos utiliza la siguiente llamada
POST https://motimateapp.com/public_api/groups

Añade la carga útil al cuerpo con la información necesaria con el grupo. El campo "parent_id" se utiliza para crear una estructura de grupo. Si introduces el ID de un grupo diferente en este campo, establecerás ese grupo como padre.

Nota: el nivel del grupo debe estar en la jerarquía inferior a la del grupo padre, siendo el "Nivel 1" el nivel más alto. Esto te permite importar estructuras de grupo a tu cuenta de Motimate. 

Actualizar grupos 

Para actualizar un grupo en Motimate necesitarás la siguiente llamada. El id utilizado en este ejemplo es el id del grupo Motimate. 

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

Añade la carga útil al cuerpo con los datos necesarios que desees actualizar en los Grupos. Esto se puede utilizar cuando hay que mover un Grupo a un nivel diferente o si hay que ajustar la estructura. 

 

Borrar grupos

Para eliminar un grupo en Motimate necesitarás la siguiente llamada. El id utilizado en este ejemplo es el id del grupo Motimate. Establecer la fuerza en "1" destruirá el registro, no hay forma de recuperar el grupo en este caso.

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

Al ejecutar esta llamada se eliminará el grupo seleccionado, aunque no se devuelve una respuesta:

 

Crear usuarios

Para crear usuarios, utiliza la siguiente llamada: 

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

Añade la carga útil al cuerpo con la información necesaria del usuario. La dirección de correo electrónico o el número de teléfono serán campos obligatorios, dependiendo de la configuración de tu cuenta de Motimate. Puedes seleccionar los Grupos del usuario utilizando el campo de asignaciones de grupo. Introduce el identificador del grupo del que quieres que forme parte el usuario y su función en el grupo (miembro, administrador u observador). Recomendamos establecer assing_ancestors a "true" en la gran mayoría de los casos. Esto garantiza que los usuarios serán miembros de los grupos padre de sus grupos asignados. 

 

Actualizar usuarios

Para actualizar la información de un usuario en Motimate necesitarás la siguiente llamada. El id utilizado en este ejemplo es el id de usuario de Motimate. 

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

Añade la carga útil al cuerpo con los únicos datos necesarios que desees actualizar para el usuario.

 

Borrar usuarios

Para eliminar un usuario en Motimate necesitarás la siguiente llamada. El id utilizado en este ejemplo es el id de usuario de Motimate. Establecer la fuerza en "1" destruirá el registro, no hay forma de recuperar el grupo en este caso. Si se pone a "0", el registro se borrará suavemente, lo que permitirá recuperarlo si es necesario. 

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

Al ejecutar esta llamada se eliminará el usuario seleccionado, aunque no se devuelve una respuesta: 

Restaurar usuarios

A veces se borra un usuario por error y es necesario restaurarlo. Si se han borrado de forma suave, y no se han destruido de forma dura, se puede hacer con la siguiente llamada. El id utilizado en este ejemplo es el id de usuario de Motimate. 

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