Todas as requisições à API da Veploy exigem uma API Key válida. A chave identifica o ambiente e limita o acesso aos escopos escolhidos durante sua criação.Obter uma API Key#
1.
Acesse o painel da Veploy e selecione o ambiente que será integrado.
2.
Abra o menu Configurações.
3.
Acesse a seção Chaves API.
4.
Crie uma chave com um nome que identifique a integração.
5.
Selecione somente as permissões necessárias, como leitura de imóveis, leads
ou visitas.
6.
Copie e armazene a chave assim que ela for criada. O valor completo não será
exibido novamente.
Crie uma chave diferente para cada integração. Isso permite revogar ou rotacionar
uma credencial sem interromper os demais consumidores.Alguns campos possuem proteção adicional. Por exemplo, properties.read permite
consultar imóveis, mas as referências em owners exigem também owners.read. Sem essa
permissão, owners é retornado como uma lista vazia.Enviar a chave#
Use o header HTTP Authorization com o esquema Bearer:Respostas de autenticação#
| Status | Significado |
|---|
401 Unauthorized | Chave ausente, inválida, inativa ou expirada. |
403 Forbidden | Chave válida, mas sem o escopo necessário para o recurso. |
Proteção da credencial#
Armazene a chave em um gerenciador de secrets ou variável de ambiente.
Nunca inclua a chave em código-fonte, commits, logs ou mensagens de erro.
Não exponha a chave em aplicações frontend ou código executado no navegador.
Conceda apenas os escopos necessários para a integração.
Revogue imediatamente uma chave que possa ter sido comprometida.
Modificado em 2026-09-08 19:03:10