➤ API Pública - Convenia

Conectando a API Publica da Convenia ao Power BI

Olá! Este guia vai te orientar a configurar a API da Convenia no PowerBI. Os passos apresentados podem ser aproveitados para configurações em outros aplicativos ou sistemas.

PASSO A PASSO


Passo 1) Clique no ícone do seu perfil localizado no canto superior direito da tela. No menu que se abrir, selecione a opção "Configurações".


Passo 2) Abrindo o menu de configurações vá ate a opção "API":



Passo 3) Neste passo, iremos criar um novo token, que funciona como a “chave” que permitirá à sua empresa acessar os dados por meio da API:



Passo 4) Neste passo, você poderá selecionar quais dados estarão acessíveis através da API. É importante também nomear este novo token de maneira que facilite sua identificação no futuro:

Sugerimos que escolha estes dados de acordo com sua demanda, evitando que dados
sensíveis, como salário, fiquem expostos sem necessidade


Passo 5) Ao finalizar sua seleção, clique em "Adicionar":



Pronto, você tem um novo token! Agora podemos configurar o PowerBI. Copie o token pois o usaremos nos próximos passos.



NO POWER BI


Passo 1) No Power BI Desktop, em um projeto novo. Clique em Obter dados de outra fonte ou em Obter dados > Mais...



Passo 2) Nesse menu, selecione a opção "Outro", depois escolha "Web" e clique em "Conectar":



Passo 3) Agora, vamos proceder com a configuração da conexão à API Convenia. Selecione a opção "Avançadas" e, em "Partes de URL", insira o endereço https://public-api.convenia.com.br/. Em seguida, adicione a API que você deseja consultar. Por exemplo, utilizaremos a rota: api/v3/employees, que retorna os dados de todos os colaboradores conforme as seleções que fizemos ao criar o token. Para explorar as APIs disponíveis, você pode acessar o seguinte link: https://docs-api.convenia.com.br/#introducao.



Passo 4) Agora em Parâmetros do cabeçalho de solicitação HTTP, insira no primeiro campo o valor “token” e no segundo o token cadastrado anteriormente. Então clique em OK:



Passo 5)
O editor do Power Query será exibido. Vamos configurar o  retorno da API para uso como fonte de dados. Clique em List:



Isso abrirá a lista dos resultados, mas ainda estão retraídos. Clique com o botão direito na barra
amarela:



Passo 6)
No menu de contexto clique em "Para a Tabela"  sem alterar nenhuma opção e clique em OK:




Passo 7) O resultado foi convertido para Tabela. Para expandirmos os registros, clique no ícone de expansão:


Passo 8) Selecione os campos dos registros que deseja utilizar para sua nova fonte de dados e clique em OK:



Passo 9) Temos uma nova fonte de dados! Para utilizá-la no PowerBI clique em Fechar e Aplicar:



Passo 10) Sua nova fonte de dados está disponível! Selecione os campos para realizar suas conexões e pesquisas:



Com isso, concluímos nosso tutorial. Esperamos que as informações tenham sido úteis para você! Se você encontrar alguma dificuldade ou precisar de esclarecimentos adicionais, não hesite em contatar nossa equipe de atendimento. Estamos à disposição para ajudar!