O que é a API de relatório do LMS NEXT?

O termo API, vem da expressão Application Programming Interface, ou, em português, Interface de Programação de Aplicativos, sua função é conectar sistemas permitindo a troca de dados entre estes, na maior parte das vezes com objetivo de automatizar processos e/ou permitir a criação de novas funcionalidades. 

A EADSKILL disponibiliza a API de Relatórios LMS NEXT para que nossos clientes possam captar informações de cadastros e progressos dos colaboradores e consolidá-los com a disposição desejada, sejam em ferramentas de BI de mercado ou aplicações proprietárias 

Como acessar a funcionalidade na plataforma:

Passo 1. Clique em "NEXT Dashboard" na aba "Relatórios" e "API de relatórios".

Passo 2.  Quando você acessar na primeira vez, ele virá desativado. Para ativar selecione a opção "Sim". Ativando irá aparecer a documentação da API, um menu de seleção (menu drop-down) para escolher o relatório desejado e por último o link da base.

Clicando na opção de "Visualizar documentação", você será redirecionado para uma página que contém a documentação da API:

OBSERVAÇÕES IMPORTANTES:

Caso você escolha o relatório e ele não aparecer o link, clique em salvar que a página será atualizada e o link aparecerá.

Para cada consulta há um retorno padronizados dos dados, estes podem ser complementados com filtros específicos para consolidar as informações desejadas, para utilizá-los basta acrescentar ao final do link padrão o valor " & " e em seguida o nome do parâmetro desejado. 

Exemplo de aplicação dos filtros na listagem de usuários: 

  • link padrão da listagem de usuários (segmento gerado automaticamente na funcionalidade) 

  • value[status] = 0

  • value [org] = Matriz 

  • value [pos] = Vendedor 

  • value[dep] = Comercial

Retorna todos os usuários com status 0 (ativos), da organização Matriz, com o cargo de Vendedor e pertencentes ao departamento Comercial. 

O link padrão com a inclusão dos filtros ficará da seguinte maneira: 

https://seulmsnext/moodle/webservice/rest/server.php?wsfunction=local_report_api_get_users_list&wstoken=0ff09a5d1af44&moodlewsr estformat=json&value[status]=0&value[org]=Matriz&value[pos]=Vendedor&value[dep]=Comercial 

A parte em destaque são os filtros que podem ser parametrizados manualmente conforme a documentação de cada consulta.

• Em caso de busca por texto, poderá ser usado apenas uma parte do conteúdo. Por exemplo, o cargo Desenvolvedor de Multimídia, mas o parâmetro de busca está "value[pos]=multi", ou seja, o filtro trará todas as posições que possuírem esse texto na sua composição.
  
  
• Para consultas que tenham "value[page]" na sessão de filtros, utilize o número da página para retornar novos resultados. Para esses relatórios, o uso do parâmetro é obrigatório. Cada página terá 5000 dados. Valor da página iniciado em "1".
  
  
• Para consultas com "value[initialdate]" e "value[finaldate]", o período máximo não deve ser superior a 31 dias, caso estes filtros não sejam utilizados, esse mesmo período será subtraído da data atual de consulta.
  
  
• No relatório de feedbacks, serão aceitas respostas somente do tipo: múltipla escolha, texto curto, textarea e rótulo.  

Como utilizar a API no Power BI:

Para utilizar no power BI, vá até a opção "Obter dado" e depois clique em "Web". Em seguida cole o link e clique em ok, após isso aparecerá outra janela e clique "continuar" e abrirá o power query para você editar e confirmar as informações:

Relatórios disponíveis e seus dados:

1 . Listagem de usuários

Retorna em uma estrutura de dados, um objeto contendo os usuários da plataforma. 

2 . Listagem de cursos

Retorna em uma estrutura de dados, todos cursos cadastrados no LMS. 

3 . Cursos completos

Retorna em uma estrutura de dados, um objeto contendo as conclusões de cursos dos usuários. 

4 . Atividades completas

Retorna em uma estrutura de dados, um objeto contendo as conclusões de atividades dos usuários

5 . Visualização de atividade

Retorna em uma estrutura de dados, um objeto contendo os acessos em atividades por curso e usuário 

6 . Progresso nos cursos

Retorna em uma estrutura de dados, um objeto contendo o progresso dos usuários em cursos

7 . Progresso em trilhas

Retorna em uma estrutura de dados, um objeto contendo o progresso nas trilhas

8 . Engajamento dos cursos

Retorna em uma estrutura de dados, um objeto contendo os colaboradores da plataforma.

9 . Listagem de pontos

Retorna em uma estrutura de dados, todos cursos cadastrados no LMS. 

10 . Listagem de moedas

Retorna em uma estrutura de dados, as moedas dos usuários na gamificação.

11 . Listagem de acesso dos usuários no LMS

Retorna em uma estrutura de dados, um objeto contendo os acessos dos usuários no LMS

12 . Listagem de feedback dos usuários

Retorna em uma estrutura de dados, um objeto contendo as respostas de feedbacks