Ferramentas de relatórios externos oferecem vários benefícios, incluindo visualização de dados aprimorada, opções de personalização e processos automatizados de relatórios. As instituições podem analisar facilmente conjuntos de dados complexos usando diversos tipos de tabelas, gráficos e painéis. Ao personalizar os elementos de dados exibidos, elas podem adaptar os relatórios a necessidades específicas que tenham. Com os relatórios automatizados, os usuários economizam tempo e recursos valiosos, simplificando a geração de relatórios.
Ao combinar os recursos de recuperação de dados da API do Ally com os recursos avançados de visualização e análise de ferramentas de relatórios populares, as instituições podem desbloquear informações para facilitar decisões baseadas em dados.
Consulte a documentação técnica Pontos de extremidade da API de relatórios para saber como configurar e personalizar adequadamente seus pontos de extremidade.
Antes de começar
Para integrar a API do Ally com a ferramenta de relatórios de sua preferência, você precisará do seguinte:
- Uma ferramenta externa de relatórios, como Power BI, Tableau, Microsoft Excel, SAP Analytics, entre outras
- Acesso ao relatório institucional do Ally (somente para administradores)
- Código da API de autorização (disponível no relatório institucional)
- URL do ponto de extremidade (disponível nesta página de ajuda)
- Seu código de cliente do Ally (entre em contato com o Atendimento ao cliente se você não tiver esse código)
Tenha em mente que você precisará alternar entre esta página de ajuda, o relatório institucional e a ferramenta externa de relatórios para configurar tudo com sucesso.
Como integrar a API do Ally a uma ferramenta externa de relatórios
- Acesse o relatório institucional. Saiba como acessar o relatório institucional.
- Na guia Visão geral, selecione o botão Exportar à direita.
- Selecione Conectar ferramenta externa.
- Um modal será exibido com um código gerado automaticamente. Selecione Copiar código.
Os códigos de API expiram após um ano. Para obter um novo código, siga este guia para configurar sua ferramenta externa de relatórios novamente.
- Acesse a ferramenta externa de relatórios de sua preferência. Neste exemplo, mostraremos como configurar a API do Ally com o Power BI.
Outras ferramentas de relatórios externos têm interfaces diferentes, no entanto, todas elas seguem etapas semelhantes às mostradas abaixo. Caso precise de assistência para configurar sua fonte de dados, consulte a documentação da ferramenta de relatórios que você utiliza.
- Abra a área de trabalho do Power BI
- Selecione Obter dados nas opções da guia Início.
- Selecione Web na lista exibida.
- Selecione a opção Avançado no modal Da web.
- Digite Autorização no campo Parâmetro do cabeçalho da solicitação HTTP.
- Na caixa de texto à direita, digite Portador, adicione um espaço e cole o código do relatório institucional.
- Copie um dos seguintes URLs do ponto de extremidade:
- https://[Região]/api/v2/clients/[Código de cliente do Ally]/reports/overall
- https://[Região]/api/v2/clients/[Código de cliente do Ally]/reports/issues
Os dados de relatório do Ally podem ser divididos em Gerais e Problemas. Ambos se aplicam a todos os seus cursos na sua instituição. Selecione o URL do ponto de extremidade de sua preferência.
- Cole o URL do ponto de extremidade no campo de caminho do URL no modal Da web do Power BI.
- Substitua o [Código de cliente do Ally] pelo seu código exclusivo do Ally.
Se você não tiver esse código, entre em contato com o Atendimento ao cliente. Lembre-se de que é o código de cliente do Ally, não o código do LMS.
- Substitua [Região] conforme a região em que o ambiente Ally da sua instituição estiver hospedado:
- Centro de dados dos EUA: prod.ally.ac
- Centro de dados do Canadá: prod-ca-central-1.ally.ac
- Centro de dados da Europa: prod-eu-central-1.ally.ac
- Centro de dados de Singapura: prod-ap-southeast-1.ally.ac
- Centro de dados da Austrália: prod-ap-southeast-2.ally.ac
- Após a conclusão dessas etapas, o modal Da Web do Power BI deve se parecer com o seguinte:
- Selecione OK para iniciar a consulta com base nas informações fornecidas.
Dependendo do número de registros, o conjunto de dados pode precisar de algum tempo de preparação. O Ally responde com um "status" informando ao usuário se os dados ainda estão sendo processados. No Power BI, você pode ver isso selecionando os "Metadados expandidos" e pesquisando a coluna metadados.status:
Enquanto o status for "Em processamento", você precisará aguardar até que os dados estejam prontos. Selecione o botão "Atualizar visualização" na faixa superior para chamar a API novamente e ver se os dados estão prontos. Se o conjunto de dados estiver pronto, todos os registros serão exibidos e a coluna metadados.status mostrará o status "Bem-sucedido".
- Por fim, selecione Fechar e Aplicar no canto superior esquerdo.
Hora de atualização dos dados
Os dados de origem são atualizados internamente a cada 15 minutos para qualquer um dos pontos de extremidade. Leve isso em consideração ao chamar o ponto de extremidade para recuperar os dados dos seus relatórios.
Limite de resposta
Tenha em mente que o limite de resposta por invocação de ponto de extremidade é de 10 mil registros. Se alguns registros não forem exibidos nos primeiros 10 mil registros, será preciso usar as opções de filtragem ou de classificação.
