Neste artigo, você aprenderá a gerar um Token na plataforma AEVO, configurar suas permissões e codificá-lo, além de explorar a Documentação da API e aprender como usar dados de uma API como fonte no Power BI. A partir dos índices abaixo você poderá ir até o tópico específico da sua dúvida: clique na opção que melhor se encaixa em sua necessidade.
- Como Gerar o Token na Plataforma?
- Codificando o Token
- Onde Localizar a Documentação de API AEVO?
- Como Usar Dados de uma API como Fonte no Power BI?
- Conclusão
Como Gerar o Token na Plataforma?
Para gerar o Token na plataforma, inicie acessando o seu Ambiente. Navegue até o menu de engrenagem > Integração e clique no botão de adição (+) para iniciar a criação do Token. Ao criar o token, insira as informações solicitadas, como o HOST, e selecione as tags relevantes que definem as permissões do token. No campo do HOST, cole a URL do seu Ambiente e confirme que está corretamente preenchida. Após salvar, o sistema exibirá o token gerado e as permissões liberadas.
Captura da tela de criação do token: insira o HOST e selecione as tags necessárias.
Ao definir as permissões, você pode:
- Limitar o acesso — conceder apenas permissão de leitura/consulta para casos em que a API precisará apenas obter dados;
- Criar um token mestre — selecionar todas as tags para gerar um token com autorizações abrangentes, útil quando múltiplos acessos são necessários.
| Importante: Recomenda-se selecionar todas as tags para gerar um token completo, eliminando a necessidade de criar múltiplos tokens para cada permissão individual. Isso simplifica a gestão dos tokens, proporcionando uma abordagem mais eficiente e organizada. |
Codificando o Token
Para consumir as APIs, o token deve estar codificado. A plataforma gera o token em formato decodificado; portanto, é necessário codificá-lo antes de utilizá-lo em uma URL de requisição. Proceda da seguinte forma:
- Copie o token gerado pela plataforma e mantenha-o disponível.
- Abra o console do navegador (pressione F12).
- No console, execute o comando encodeURIComponent("seu_token") e pressione Enter. O resultado exibido será o token codificado.
- Copie o token codificado e utilize-o nas rotas da API conforme demonstrado na documentação.
Exemplo: execução do comando encodeURIComponent no console do navegador para codificar o token.
Observações sobre o processo de codificação:
- Por que codificar: a codificação garante que caracteres especiais presentes no token não quebrem a URL da requisição.
- Resultado esperado: tokens codificados normalmente terminam com "3D", indicando que foram corretamente transformados em formato seguro para URLs.
- Efeito: com o token codificado, você poderá consumir as rotas externas da API sem problemas de formatação na URL.
Onde Localizar a Documentação de API AEVO?
A documentação das APIs do Innovate está disponível no portal de documentação e descreve os métodos GET e POST suportados. Este artigo concentra-se no método GET para acessar as informações que você configurou ao gerar o token na plataforma. Consulte a documentação completa para entender todos os endpoints e parâmetros.
Acesse a documentação em: APIs do Innovate
Visão geral da documentação: selecione a rota desejada e consulte parâmetros e exemplos.
Para consumir um endpoint, substitua "seu_token" pelo token codificado e inclua a URL do seu ambiente. Exemplo de rota para listar ideias:
https://seuambiente/webapi/api/apiexterna/v2/GetIdeias?token='seu-token-codificado'
Resultado e efeito: ao acessar essa URL com o token válido e codificado, a rota webapi/api/apiexterna/v2/GetIdeias retornará os dados de ideias permitidos pelas permissões do token. Verifique na documentação outras rotas disponíveis e seus parâmetros.
Como Usar Dados de uma API como Fonte no Power BI?
Integrar dados de uma API ao Power BI permite criar relatórios dinâmicos e atualizados. Neste artigo, utilizaremos o URL do endpoint como fonte. Antes de iniciar, certifique-se de ter o endpoint da API que retorna os dados desejados e o token codificado pronto para autenticação.
Passos resumidos para conectar a API ao Power BI:
- Obtenha o endpoint da API que retorna os dados necessários.
- Abra o Power BI Desktop no seu computador.
- Clique em Obter Dados e selecione Web.
- Insira o URL do endpoint (incluindo o token codificado, se for parte da query string) e clique em OK.
- Utilize o Power Query Editor para transformar, filtrar e modelar os dados antes de carregar no relatório.
Tela do Power BI Desktop: inserir o URL do endpoint na opção "De Web".
Após a conexão, o uso do Power Query Editor permite:
- Visualizar os dados retornados pela API;
- Filtrar e transformar colunas, tipos e estruturas;
- Modelar as tabelas antes de criar visualizações no Power BI.
Power Query Editor: preparar dados da API antes de criar relatórios.
| Importante: mantenha o token codificado em local seguro e não o compartilhe publicamente. Caso precise rotacionar credenciais, gere um novo token na plataforma e atualize as configurações dos consumidores (por exemplo, URLs no Power BI). Selecionar todas as tags ao gerar um token simplifica a gestão, porém garanta que apenas usuários e sistemas autorizados tenham acesso ao token mestre. |
Conclusão
Geração do Token: acesse Ambiente > engrenagem > Integração e clique em (+) para criar o token, informando o HOST e selecionando as tags. Codificação: use encodeURIComponent no console do navegador para codificar o token antes de usá-lo em requisições. Documentação: consulte as APIs do Innovate para rotas e parâmetros. Power BI: utilize a opção De Web no Power BI Desktop para inserir o endpoint (com token codificado) e prepare os dados no Power Query Editor antes de criar relatórios.
Artigos relacionados: