Perguntas frequentes sobre a API

P: O que é Início único de sessão (SSO)? Como meus alunos podem iniciar sessão na Voxy direto do meu site ou LMS?

R: A Voxy Partner API permite que os usuários tenham a experiência de Início único de sessão. Dessa forma, você pode iniciar a sessão deles automaticamente na Voxy sem que eles precisem de senha. Para isso, você deve solicitar uma URL da Partner API que inclua um auth_token que permita que o aluno inicie sessão no aplicativo Voxy.

No corpo da resposta da API, você receberá uma start_url. Sempre que um usuário precisar acessar a Voxy, você pode solicitar a start_url e redirecioná-lo à URL incluída. Dessa forma, o usuário receberá acesso automático à conta dele na Voxy.

IMPORTANTE: o auth_token será invalidado assim que for usado ou da próxima vez que o usuário iniciar sessão na plataforma Voxy. Portanto, você deve solicitar a URL de início de sessão no momento em que o usuário estiver tentando acessar a Voxy, e solicitar outra sempre que ele precisar iniciar sessão.

Dessa forma, é possível criar uma experiência perfeita para os usuários. Por exemplo, é possível criar um formulário de início de sessão no seu site ou sistema, em que o usuário possa clicar em um botão e entrar automaticamente na Voxy. Dessa forma, o usuário tem a impressão de que está interagindo com o mesmo sistema, quando na verdade são dois diferentes. Por isso, a ativação do início único de sessão costuma ser uma tarefa obrigatória que deve ser realizada por clientes White Label.

 

P: Como posso revogar ou negar o acesso de um aluno?

R: O acesso de um aluno à Voxy é definido pela expiration_date salva no perfil de usuário dele. Os alunos que têm data de expiração anterior ao dia atual têm acesso negado à plataforma Voxy. Se precisar impedir que um usuário específico acesse a plataforma, atualize a data de expiração dele com uma solicitação PUT para https://partner-api.voxy.com/partner_api/partners/users/{external_user_id}/, incluindo o parâmetro expiration_date com uma data anterior ao dia atual.

  

P: Qual é a diferença entre ambientes de “teste” e “produção”?

R: O ambiente de “teste” pode ser usado para fazer experiências durante a integração da API. O ambiente de “produção” é acessado pelos usuários reais. NÃO faça testes no ambiente de produção. É possível criar quantos usuários falsos for necessário no ambiente de “teste”, sem se preocupar em causar problemas em dados reais. 

Esses ambientes são acessados por URLs diferentes:

Também é necessário usar uma API_KEY e um API_SECRET diferentes para cada ambiente.  O Customer Success Manager da Voxy pode oferecer uma API_KEY e um API_SECRET para os ambientes de “teste” e “produção”.

Quando você estiver pronto para o lançamento, seu código deve substituir todas as referências ao ambiente de teste por referências ao ambiente de “produção”. O código deverá conter um domínio diferente nas URLs dos pontos periféricos, além de uma API_KEY, e um API_SECRET diferentes. Além disso, você criará contas de usuários reais e solicitará dados reais.

 

P: Qual é a diferença entre grupos e segmentos?

R: Um grupo ou “grupo de recursos” (feature group), é um conjunto de alunos que têm acesso aos mesmos recursos da Voxy. Por exemplo, um feature_group pode ter acesso a aulas particulares, e outro não. Seu Customer Success Manager da Voxy criará grupos de recursos com base nos pacotes de produtos adquiridos pela sua organização.

Os segmentos, ou “segmentos de relatórios”, são etiquetas que podem ser criadas e atribuídas aos usuários e, mais tarde, usadas como filtros em relatórios. Por exemplo, você pode criar segmentos para representar diferentes locais ou departamentos na sua organização. Mais tarde, você pode usá-los como filtros para dados de relatórios. Por exemplo, alguns pontos periféricos da Voxy Partner API retornam dados apenas para usuários que pertencem a um segmento especificado.

Além disso, os relatórios disponíveis nos Relatórios da Voxy podem ser filtrados por qualquer segmento personalizado criado.

Exemplo: a Voxy Partner API tem este ponto periférico: […]  Se você fizer uma solicitação GET a esse ponto periférico, receberá uma lista das sessões em grupo com a participação de todos os usuários do segmento especificado.

 

Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 0
Tem mais dúvidas? Submeter um pedido

Comentários

0 comentário

Por favor, entrar para comentar.