⚠️Atenção: para maior agilidade na utilização da API para Relatórios, recomendamos que você conecte seus dados de forma automática, usando nossos modelos de Excel e Power BI. Passo a passo completo aqui.
Se deseja fazer a conexão de seus dados manualmente, siga neste artigo.
Para você usar a API para Relatórios, siga o passo a passo dos artigos:
Passo extra (nível avançado): Conectando, de forma manual, a API para Relatórios às ferramentas de análise
Carregamento dos Dados
Para conectar a API à sua ferramenta de análise e carregar os dados, você precisa:
Ter ativado a API e estar com a credencial de acesso.
Ter os links de acesso das tabelas.
Links das tabelas
Para acessar os seus dados na API, insira os links das tabelas abaixo na sua ferramenta de dados:
Tabela de dados | Links das tabelas |
Lançamentos | |
Pagamentos | |
Faturamentos | |
Recebimentos | |
Cadastro de Obras | |
Cronogramas | |
Cronograma Físico-financeiro | |
Orçamentos | |
Medições | |
Propostas |
Agora, o próximo passo é o carregamento dos dados. Para isso, é necessário utilizar algum software de dados, como: Excel, Power BI, Google Sheets etc.
Tutorial Excel
Tutorial Excel
Vídeos de passo a passo:
Se conectando com a API no Excel:
Obras:
Cronograma:
Cronograma Físico-financeiro:
Orçamento:
Medições:
Lançamentos:
Pagamentos:
Faturamentos:
Recebimentos:
Algumas dicas:
Passo a passo:
Passo 1: Como carregar os dados no Excel
Abrir arquivo Excel > Dados > Obter e Transformar Dados > Da Web > Link URL da tabela > OK > Básico > Nome do usuário e senha > Conectar > Transformar dados.
Passo 2: Edições no Power Query
Para garantir a interpretação correta de seus dados no Excel, é necessário realizar algumas correções e análises no editor do Power Query.
Inicialmente, é crucial verificar se os dados possuem o "tipo de dados" correto associado a eles. Por exemplo, é importante garantir que a coluna de datas esteja configurada corretamente como tipo de data.
Um ponto relevante a ser considerado é que os valores monetários da API são carregados no formato "0.00" e não no formato brasileiro com vírgula, como "0,00". Portanto, é indispensável realizar ajustes nos valores numéricos no Power Query para assegurar que sejam carregados de maneira apropriada. Isso é essencial para evitar problemas de interpretação e garantir a integridade dos dados ao serem visualizados no Excel.
Caso você não saiba como realizar as edições no Power Query, sugerimos que assista aos vídeos acima.
Passo 3: Visualização de dados
Após todas as edições, é possível carregar os dados no Excel e, por fim, começar as análises desejadas.
Tutorial Power BI
Tutorial Power BI
Vídeos de passo a passo:
Se conectando com a API no Power BI:
Passo a passo:
Passo 1: Como carregar os dados no Power BI
Abrir arquivo Power BI > Pagina inicial > Obter e Transformar Dados > Da Web > Link URL da tabela > OK > Básico > Nome do usuário e senha > Conectar > Transformar dados.
Passo 2: Edições no Power Query
Para garantir a interpretação correta de seus dados no Power BI, é necessário realizar algumas correções e análises no editor do Power Query.
Inicialmente, é crucial verificar se os dados possuem o "tipo de dados" correto associado a eles. Por exemplo, é importante garantir que a coluna de datas esteja configurada corretamente como tipo de data.
Um ponto relevante a ser considerado é que os valores monetários da API são carregados no formato "0.00" e não no formato brasileiro com vírgula, como "0,00". Portanto, é indispensável realizar ajustes nos valores numéricos no Power Query para assegurar que sejam carregados de maneira apropriada. Isso é essencial para evitar problemas de interpretação e garantir a integridade dos dados ao serem visualizados no Excel.
Caso você não saiba como realizar as edições no Power Query, sugerimos que assista o vídeo acima.
Passo 3: Visualização de dados
Após todas as edições, é possível carregar os dados no Excel e, por fim, começar as análises desejadas.
Códigos de Resposta da API
Código | Descrição |
200 | Sucesso. Retorna a listagem dos dados da rotina no formato CSV. |
401 | Erro. Sem permissão de acesso à listagem da rotina. Problema com login e senha informados. |
422 | Erro. Ops. algo deu errado, favor contactar o suporte. |
429 | Erro. Número de solicitações de geração acima do limite permitido para o modelo contratado. |
Cenários de exceção que podem ocorrer
Há alguns cenários de exceção na utilização da API que são comuns. Saiba como corrigi-los:
Caso sejam feitas chamadas à API acima do limite de requisições permitidas, provavelmente você irá se deparar com uma mensagem como esta:
Para corrigir, basta aguardar a data de renovação das requisições, que ocorre conforme o modelo contratado (semanal, diária ou de hora em hora) e chamar novamente a API.
Porém, atentar para o fato de que as requisições renovam não necessariamente junto à atualização, elas renovarão conforme a data que foi feita a última requisição. São situações distintas: a atualização da renovação da requisição.
Por exemplo, digamos que você chamou a API pela primeira vez em 04/06/2024 14:30 no modelo semanal e usou todas as requisições da semana. Você poderá acessar a API novamente em 11/06/2024 a partir das 14:30, mesmo que a atualização dos dados tenha ocorrido em 09/06/2024 às 03h da manhã.
Nos modelos diários e hora em hora isso dificilmente ocorrerá, pois o modelo conta com mais requisições e mais recorrentes também.
Caso a senha de acesso à API esteja errada.
Para corrigir, verifique com o usuário-chave da sua empresa se a senha foi alterada e se você está com as credenciais corretas.
Caso o link da tabela esteja incompleto, você verá uma mensagem similar a esta:
Para corrigir o erro, basta copiar o link por completo e tentar novamente.
Espero ter conseguido te ajudar. 🚀
Um abraço!
Equipe Mais Controle 👷🏽