https://api.nuvia.ai.
A coleção é gerada a partir da mesma especificação que alimenta a Referência, então as duas mostram
exatamente a mesma superfície.
Baixar a coleção
Baixar coleção do Postman (.zip)
Arquivo
.zip com a coleção no formato Postman v2.1. Descompacte para obter o
nuvia-postman-collection.json.O download é um
.zip. Descompacte-o antes de importar — dentro há um único arquivo,
nuvia-postman-collection.json, que é a coleção em si.Importar no Postman
1
Descompacte o arquivo
Extraia o
.zip baixado. Você terá o arquivo nuvia-postman-collection.json.2
Importe no Postman
No Postman, clique em Import (canto superior esquerdo) e selecione o
nuvia-postman-collection.json. A coleção Nuvia API aparece na barra lateral, com os
endpoints agrupados por domínio: Agentes, Contatos, Conversas, Mensagens, Caixas de Entrada,
Campanhas, Inscrições em Campanha, Tabelas e Listas, Base de Conhecimento e Webhooks.3
Configure as variáveis
A coleção usa duas variáveis. Abra a coleção Nuvia API, vá até a aba Variables e
preencha:
Salve. Veja como gerar uma chave no Guia de API Key.
4
Faça a primeira chamada
Escolha qualquer requisição de leitura (por exemplo, listar agentes) e clique em Send.
A autenticação já está configurada na coleção — cada requisição herda o Bearer Token com a
sua
NUVIA_API_KEY.Como a autenticação está configurada
A coleção define a autenticação no nível da coleção: o tipo é Bearer Token e o token é a variável{{NUVIA_API_KEY}}. Todas as requisições herdam essa configuração, então você não
precisa preencher o cabeçalho Authorization em cada uma — basta definir a variável NUVIA_API_KEY
uma vez.
A coleção cobre só o que uma API Key consegue chamar. O fluxo de login da plataforma e a gestão
de chaves (
/v1/api-keys) exigem o token de usuário e ficam de fora — veja o
Guia de API Key para criar e revogar chaves.Algumas requisições trazem o cabeçalho
x-company-id desabilitado. Ele só é necessário para
API Keys globais de uso interno; com uma chave de empresa, deixe como está.Próximos passos
Autenticação
Como autenticar suas chamadas com uma API Key.
Exemplos de integração
Casos de uso completos com cURL, JavaScript e Python.