Como utilizar a API do Prevision Incorporação

A API da Prevision foi desenvolvida para oferecer mais autonomia e flexibilidade aos usuários que desejam integrar os dados da plataforma com sistemas externos, como ferramentas de BI (ex: Power BI) ou sistemas internos da empresa. 

⚠️ Importante: Este artigo refere-se à API da plataforma Prevision Incorporação. Para acessar dados da plataforma de Obra, consulte este artigo específico. 

O que é possível fazer com a API?  

A API permite consultar dados da plataforma de forma estruturada, facilitando integrações com sistemas externos e análises personalizadas. A documentação completa com os endpoints disponíveis está em: https://api.prevision.com.br. 

Como gerar o token de acesso 

Para utilizar a API, é necessário gerar um token de autenticação. Apenas usuários com perfil Administrador na plataforma desejada podem gerar tokens. 

Passo a passo para gerar o token: 

1. Acesse a Home da plataforma e clique em Configurações.  
   
        
    
2. Vá até a seção API Token e clique em Criar Token.          
   
   
    
3. Preencha os campos da modal:

• Descrição: Nome que identifique o uso ou propósito do token (ex: “Integração com Power BI”). 
• Plataformas: Selecione em quais plataformas o token será válido (só é possível criar tokens para plataformas em que o usuário é administrador). 
• Data de expiração: Defina uma data de validade para o token. Por segurança, recomendamos evitar tokens sem expiração. 

   4. Após a criação, o token será exibido apenas uma vez. Copie e salve o token com segurança antes de sair da tela. 

Orientações gerais 

Para utilizar a API recomendamos a instalação de algum software auxiliar. Alguns bons exemplos: 

• Postman: rica IDE que permite criar coleções e gerenciar múltiplos exemplos e execuções; 
• Altair: possui uma IDE e extensões para os principais navegadores WEB; 
• Insomnia: outra IDE amplamente utilizada. 

Sugerimos as seguintes boas práticas: 

• Evite sobrecarga: Para grandes volumes de dados, priorize consultas fora do horário comercial (antes das 08h ou após as 19h). 
• Consumo excessivo: Em caso de uso abusivo, a Prevision poderá limitar ou suspender temporariamente o acesso à API. 
• Responsabilidade do uso: A integração com sistemas externos (como Power BI) é de responsabilidade do cliente. 

Suporte técnico 

O suporte à API é realizado por um desenvolvedor da Prevision. Dúvidas ou problemas? Envie uma mensagem para o chat da plataforma Prevision.