Overview#
A API da Veploy permite integrar sistemas externos aos dados do ambiente autenticado. A API segue um contrato REST em JSON, versionado na URL, e utiliza API Keys com permissões explícitas.URL base#
Todos os recursos ficam sob /v1. A referência ao lado lista os que existem
hoje, agrupados por recurso: cada um oferece uma coleção paginada e a consulta
individual por seu identificador público.Primeira requisição#
Depois de criar uma API Key no painel da Veploy, envie-a como Bearer token:Consulte o guia Autenticação para criar, armazenar e utilizar a chave.Convenções#
Coleções usam paginação numerada com page e per_page.
per_page aceita no máximo 100 itens.
Datas e horários seguem ISO 8601.
Valores monetários são strings decimais para preservar precisão.
Campos previstos pelo contrato, mas sem valor, podem ser retornados como
null.
Erros usam o envelope { "error": { "code": "...", "message": "..." } }.
As requisições são limitadas por minuto, e cada resposta informa o saldo
restante nos headers x-ratelimit-*.
Consulte o guia Limites de requisição para os tetos de cada rota e para as
boas práticas de sincronização.Segurança e isolamento#
A API Key identifica automaticamente o ambiente e os escopos autorizados.Modificado em 2026-09-08 21:43:47