Preguntas frecuentes sobre la API

P: ¿Qué es el inicio de sesión único (SSO)? ¿Cómo pueden mis estudiantes iniciar sesión en Voxy directamente desde mi sitio web o LMS?

R: La Voxy Partner API te permite ofrecerles a tus usuarios una experiencia de inicio de sesión único con la que pueden acceder automáticamente a Voxy sin necesidad de ingresar su contraseña. Para esto, debes solicitar a la Partner API una URL que incluya un auth_token que permita a los estudiantes iniciar sesión en la aplicación de Voxy.

 

En la respuesta de la API, recibirás una start_url. Cuando un usuario necesita acceder a Voxy, puedes solicitar la start_url y redirigir al usuario a la URL incluida. Así, el usuario tendrá acceso a su cuenta de Voxy automáticamente.

 

IMPORTANTE: el auth_token se invalidará en cuanto se utilice o la próxima vez que el usuario inicie sesión en la plataforma Voxy. Por eso, tendrás que solicitar la URL de inicio de sesión en el momento en que el usuario está intentando acceder a Voxy y solicitar una URL nueva cada vez que el usuario necesite iniciar sesión.

 

Esto te permite crear una experiencia integrada para los usuarios. Por ejemplo, puedes crear un formulario de inicio de sesión en tu sitio web o en tu sistema para que los usuarios puedan iniciar sesión en Voxy con solo hacer clic en un botón. De esta manera, el usuario piensa que está interactuando con el mismo sistema, cuando en realidad se trata de dos sistemas. Por lo tanto, el inicio de sesión único suele ser una función necesaria para nuestros clientes de marca genérica.

 

P: ¿Cómo puedo revocar o negar el acceso a un estudiante?

R: El acceso de un estudiante a Voxy está sujeto al parámetro expiration_date guardado en su perfil. Los estudiantes que tienen una fecha de vencimiento anterior a la fecha actual no podrán acceder a la plataforma Voxy. Si necesitas negar el acceso de un usuario específico, debes actualizar la fecha de vencimiento de su perfil mediante una solicitud PUT a https://partner-api.voxy.com/partner_api/partners/users/{external_user_id}/. Recuerda cambiar el parámetro expiration_date por una fecha pasada.

 

 

P: ¿Cuál es la diferencia entre el entorno de prueba y el de producción?

R: El entorno de prueba es muy útil en la etapa de configuración porque permite evaluar la integración con la API. El entorno de producción es un entorno que solo deberías usar con tus usuarios reales. NO se deben realizar pruebas en el entorno de producción. En el entorno de pruebas, puedes crear tantos usuarios falsos como necesites. De esta manera, no tienes que preocuparte por arruinar datos reales. 

 

Se utiliza una URL diferente para acceder a cada uno de los entornos:

 

Además, necesitas una API_KEY y un API_SECRET diferentes para cada entorno.  Tu Customer Success Manager de Voxy puede brindarte una API_KEY y un API_SECRET para el entorno de pruebas y el entorno de producción.

 

Cuando estés listo para la implementación, el código deberá reemplazar cualquier mención del entorno de pruebas por menciones sobre el entorno de producción. Tu código deberá usar un dominio diferente en las URL de los puntos de conexión, así como una API_KEY y un API_SECRET diferentes. Ten en cuenta que estarás creando cuentas de usuario reales y enviando solicitudes de datos reales.

 

P: ¿Cuál es la diferencia entre grupos y segmentos?

 

R: Un grupo, o grupo de funcionalidades (feature_group), es un conjunto de estudiantes que tienen acceso a las mismas funcionalidades de Voxy. Por ejemplo, un feature_group podría tener acceso a clases particulares, mientras que otro grupo, no. Tu Customer Success Manager de Voxy creará grupos de funcionalidades basándose en los paquetes de producto que haya comprado tu organización.

 

Los segmentos, o segmentos de informe, son etiquetas personalizadas que puedes crear y asignar a usuarios para usarlas como filtros en los informes. Por ejemplo, puedes crear segmentos para representar diferentes sedes o departamentos dentro de tu organización. Luego, puedes usar los segmentos para filtrar los datos de los informes. Por ejemplo, algunos puntos de conexión de la Voxy Partner API ofrecen solo datos de usuarios que pertenecen a segmentos específicos.

 

Además, los informes disponibles en Voxy pueden filtrarse por cualquier segmento personalizado que hayas creado.

 

Por ejemplo, la Voxy Partner API tiene el siguiente punto de conexión: [...] Si envías una solicitud GET a este punto de conexión, obtendrás una lista de la cantidad de sesiones grupales a la que asistieron todos los usuarios de un segmento específico.

 

 

 

¿Fue útil este artículo?
Usuarios a los que les pareció útil: 0 de 0
¿Tiene más preguntas? Enviar una solicitud

Comentarios

0 comentarios

Inicie sesión para dejar un comentario.