Motimate: ¿Cómo utilizar la API pública de Motimate?
Utiliza la API Pública para automatizar la integración de usuarios y la sincronización con tu fuente de datos, y conecta Motimate a otros servicios geniales 🔀.
¡La API pública v2 ya está disponible para todos los clientes!
- Documentación para PAPI v1 (Sólo versiones anteriores - todos los nuevos clientes recibirán la v2)
- Documentación del PAPI v2
La API pública es un conjunto de servicios que se pueden utilizar para actualizar y gestionar datos en Motimate. Está documentada de forma estándar, denominada OpenAPI, y proporciona a los desarrolladores acceso programático a nuestro software como servicio. Esta API tiene un soporte más amplio que lo que puedes hacer con SCIM y CSV, pero necesitas un servicio de integración o un robot de software para utilizarla.
El lanzamiento de PAPI v2 facilita más que nunca la exportación de datos desde tu MotiSpace, con puntos finales como:
Tenlo en cuenta:
- Tienes que solicitar tus credenciales de la API al Servicio de Asistencia para empezar a utilizar este servicio.
- La base de datos de la API se actualiza a intervalos regulares , unas cuantas veces cada hora.
Modelos de datos
La API pública proporciona modelos para automatizar el aprovisionamiento de usuarios y los mensajes Pulse. Tiene estos modelos de datos:
-
Modelo de usuario: Puedes utilizarlo para leer, escribir y actualizar información sobre cuentas de usuario. Esto puede incluir información de contacto, funciones de acceso y asignaciones de grupo para la gestión de moti. Si un usuario tiene una o varias posiciones, también se puede establecer en este punto final.
-
Modelo de grupos: Te permite leer, escribir y asignar grupos de usuarios. Estos grupos también pueden estructurarse en forma de árbol para adaptarse a tu organización y simplificar las tareas de aprendizaje.
Importante: El nivel de grupo se define actualmente utilizando el atributo tipo. El valor de la clase puede variar de una organización a otra. También puede cambiarlo fácilmente el administrador de tu organización. Al configurar la integración de la API, es aconsejable definir una lista permanente de nombres de tipo para tus niveles de grupo, para evitar posibles errores en la integración de la API en caso de que cambien los nombres de tipo.
-
Modelo de posiciones: Este modelo te permite leer y escribir posiciones a las que se pueden asignar cuentas de usuario.
-
Publicaciones: Puedes utilizarlo para crear entradas y publicarlas en Pulse. Esto puede hacerse en combinación con los servicios de archivos para subir imágenes.
-
Archivos: Este servicio se utiliza para subir imágenes para Pulse Posts. El límite de tamaño de las imágenes es de 40 MB, el de los vídeos de 100 MB y el de los documentos de 100 MB.
- Información: Este servicio se utiliza para generar y obtener un enlace a un informe personalizado. La plantilla del informe debe ser creada previamente en la plataforma Motimate utilizando la función 'Generar Informes' en 'Insights'.
Autenticación
El punto final OAuth Token se utiliza para crear el token de acceso. Consigue tu client_id y client_secret poniéndote en contacto con support@motimateapp.com.
Una vez que hayas recibido estos datos, los tokens se pueden generar mediante programación o a través de plataformas como Postman. Todo lo que tienes que hacer es enviar una llamada API al punto final punto final POST /oauth/tokenscon el client_id y las credenciales client_secret que recibiste del Soporte de Motimate como cuerpo JSON.
La API responderá con un token único, que será válido durante 24 horas. Puedes generar tantas fichas como necesites. El token debe pasarse al encabezado Autorización como token Portador en tus peticiones a todos los demás puntos finales ("Portador "+[tu_token]).
Ejemplo:"Portador eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
Puedes utilizar el punto final punto final GET /me para verificar el token de acceso. Esto es útil si tienes un almacén de claves para guardar tu token de acceso y quieres verificar que funciona sin invocar ninguna llamada transaccional.
Cómo probar la API:
Para probar la API, te recomendamos que utilices una plataforma de API como Postman. Puedes encontrar una guía sobre cómo importar la documentación completa de la API de Motimate a Postman e Insomnia Collections aquí.
Debes crear tu token de acceso a la API como se ha descrito anteriormente, y luego introducir este token como token Portador en la pestaña Autorización dentro de Postman. A continuación, puedes seguir adelante y probar la API y revisar las respuestas.
0 comentarios
Inicie sesión para dejar un comentario.