Como funciona

Se sua organização tem uma equipe de desenvolvedores confiável e você estará incorporando a Voxy nas ferramentas e fluxos de trabalho existentes para administradores ou alunos, então o Partner API fornece opções para facilmente gerenciar usuários e visualizar dados de desempenho. O Partner API é uma ferramenta de self-service que as organizações podem usar para projetar, desenvolver e manter seus próprios fluxos de trabalho personalizados. Você pode ver todos os endpoints disponíveis aqui no Partner API Docs.

As funções mais frequentemente utilizadas incluem:

Registro de um novo usuário
Acompanhar dados de avaliação do usuário
Lista de atividades do usuário concluídas
Conferir o tempo de trabalho de um usuário dentro de um intervalo de datas

Normalmente leva apenas alguns dias para que sua equipe comece a trabalhar. É assim que vai funcionar:

Trabalhe com sua equipe técnica para revisar Partner API Docs e preparar um plano básico de implementação.
Compartilhe seu plano com seu Customer Success Manager da Voxy. Eles podem agendar uma consulta técnica mais aprofundada para você, se necessário.
A Voxy compartilhará sua chave e segredo API da organização e fornecerá acesso ao nosso repositório GitHub de exemplos de código em várias linguagens de programação.
Sua equipe completará o desenvolvimento de acordo com seu caso de uso personalizado.
Recomendamos que você faça testes completos de ponta a ponta antes de lançar um novo programa com uma integração API, ou antes, de liberar as principais atualizações da API para produção. Se você não tiver certeza do que testar, entre em contato com seu CSM ou com o time de Partner Support.

Notas sobre implementação

Gestão de usuários

Nossas integrações API mais bem-sucedidas são utilizadas para automatizar a criação de usuários e atualizações de contas. Isto funciona melhor se seus alunos acessarem a Voxy em um LMS ou portal existente e usarem um fluxo que você projetou para se auto-registrar.

Você pode facilmente usar o Partner API para criar usuários, bloquear o acesso (por exemplo, expirar contas), mover os alunos entre feature groups com diferentes configurações. Você precisará entrar em contato com o Partner Support para criar ou atualizar as configurações dos grupos.

O gerenciamento de usuários via API é compatível com vários métodos de autenticação (ver Visão Geral da Integração da Autenticação). Se você também estiver considerando SSO com SAML ou OIDC, recomendamos usar a criação de usuários just-in-time para criar contas.

Relatórios e Dashboards

Se você estiver interessado em usar o Partner API para configurar relatórios ou painéis de controle personalizados, nós o encorajamos fortemente a rever o Partner API Docs em detalhes para garantir que os dados disponíveis atendam às suas necessidades. Embora a Voxy continue comprometida com a funcionalidade contínua dos end points da API existente e com a integridade dos dados devolvidos, adicionamos novos recursos e relatórios ao Voxy Command Center com mais frequência do que ao Partner API.

Suporte Contínuo

A Voxy pode fornecer uma consulta inicial e suporte à medida que você começa a utilizar, porém, temos recursos limitados para ajudar no projeto e desenvolvimento das aplicações do cliente. Se sua equipe não tiver uma equipe dedicada a desenvolver e manter seus fluxos de trabalho personalizados, recomendamos enfaticamente o uso do Voxy Command Center para gerenciamento de usuários e relatórios.

Se você tiver problemas com uma integração já existente, você pode entrar em contato com o time de Partner Support com sua solicitação. Para a maioria das solicitações de suporte, pediremos as seguintes informações antes de podermos recorrer a um especialista técnico:

Uma visão geral do comportamento esperado e observado
Solicitação e resposta completa com headers e autorização
Identificadores para qualquer usuário específico (se aplicável)

Pronto para começar?

Se você tiver alguma pergunta geral, você pode entrar em contato com Partner Support. Se você estiver pronto para começar, entre em contato com seu CSM da Voxy hoje mesmo!