Integrações e API
Criar uma chave de API
Leve fotos, câmeras, timelapses e clima para o site da empresa, BI, ERP ou intranet com uma chave somente leitura, limitada por escopo, obra, origem e IP.
- Para:
- ProprietárioAdministrador
- Atualizado em
- Tempo de leitura
- 3 min de leitura
Ou perfis personalizados com a permissão “Gerenciar chaves de API”, numa empresa com o recurso “API e integrações” contratado.
Entrar para ver no appCom a sua conta, o tour guiado mostra cada passo na tela.
Uma chave de API dá acesso somente leitura a dados da empresa para outro sistema. Crie uma chave para cada site ou sistema: assim você revoga uma sem afetar as outras.
Criar a chave
Link para a seçãoAbra Integrações e API e clique em Nova chave.
Nome da chave
Algo que identifique a integração, como "Site institucional" ou "Power BI da diretoria".
- 1. Nome da chave.
- 2. Onde a chave será usada: Site da empresa, Servidor / BI ou Personalizada.
- 3. Escopos: o que a chave pode ler.
- 4. Origens e IPs permitidos.
Onde a chave será usada?
Site da empresa (a foto da obra no site, direto do navegador), Servidor / BI (ERP, BI ou intranet, com a chave guardada no servidor) ou Personalizada (você escolhe tudo). As duas primeiras já marcam os escopos e as restrições recomendadas.
Escopos e obras
Confira o que a chave pode ler e de quais obras. Libere só o necessário.
Restrições, limites e validade
Informe as origens (sites) ou os IPs permitidos, ajuste os limites se quiser e escolha a Expiração — o padrão é 1 ano.
Clique em Criar chave.
| Escopo | O que a chave lê |
|---|---|
| Câmeras | A lista de câmeras, o status e a data da última foto. |
| Imagens | A foto mais recente e o histórico de fotos, com links temporários. |
| Timelapses | Os timelapses publicados, com os links dos vídeos. |
| Ao vivo | Sessões de transmissão ao vivo — cada abertura é auditada. |
| Clima | Clima e chuvas por obra num período. |
Origens e IPs
Link para a seção- Origens permitidas (sites): os domínios que podem chamar a API pelo navegador, como
https://www.suaconstrutora.com.br. Usehttps://*.suaconstrutora.com.brpara todos os subdomínios. Sem origens, chamadas de navegador são recusadas. - IPs permitidos: recomendado para servidores. Aceita IPv4, IPv6 e faixas CIDR, como
200.150.10.0/24. Vazio aceita qualquer IP.
Guardar o segredo
Link para a seçãoNa tela Chave criada, clique em Copiar chave. O segredo aparece uma única vez — o Vealapse guarda só uma impressão criptográfica dele.
- 1. Aviso: o segredo aparece uma única vez.
- 2. Mostrar e Copiar chave.
- 3. Confirmação de que você guardou a chave.
Guarde num gerenciador de senhas ou de segredos. Em servidores, use uma variável de ambiente ou um cofre de segredos — nunca o repositório de código.
Marque Guardei a chave em um local seguro e feche.
Nas chamadas, envie a chave no cabeçalho Authorization: Bearer <chave> ou X-Api-Key. A aba Para desenvolvedores e o botão Documentação trazem os endereços e exemplos.
Limites e segurança
Link para a seção- A chave nunca lê mais do que quem a criou. Se essa pessoa perder permissões, obras ou o acesso à empresa, a chave encolhe junto.
- A empresa pode ter até 25 chaves ativas ao mesmo tempo.
- A aba Consumo mostra as chamadas de cada chave no mês.
- Para desligar uma chave, use Revogar chave na lista. A revogação vale na hora.
O site recebe erro ao chamar a API.
Confira se o endereço do site está em Origens permitidas exatamente como aparece no navegador (com https:// e sem barra no fim) e se a chave tem o escopo da chamada.
Quem pode criar chaves?
Quem tem a permissão Gerenciar chaves de API — no padrão, Proprietário e Administrador — numa empresa com o recurso API e integrações contratado.