> ## Documentation Index
> Fetch the complete documentation index at: https://developers.nuvia.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Coleção Postman

> Baixe a coleção oficial da API da Nuvia e importe no Postman para testar os endpoints

A coleção do Postman reúne os endpoints públicos da API da Nuvia já organizados por domínio,
prontos para você testar com a sua **API Key**. Ela usa as mesmas convenções descritas em
[Autenticação](/autenticacao): autenticação por **Bearer Token** e base
`https://api.nuvia.ai`.

## Baixar a coleção

<Card title="Baixar coleção do Postman (.zip)" icon="download" href="/assets/nuvia-postman-collection.zip">
  Arquivo `.zip` com a coleção no formato Postman v2.1. Descompacte para obter o
  `nuvia-postman-collection.json`.
</Card>

<Note>
  O download é um `.zip`. Descompacte-o antes de importar — dentro há um único arquivo,
  `nuvia-postman-collection.json`, que é a coleção em si.
</Note>

## Importar no Postman

<Steps>
  <Step title="Descompacte o arquivo">
    Extraia o `.zip` baixado. Você terá o arquivo `nuvia-postman-collection.json`.
  </Step>

  <Step title="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 (contatos, conversas, mensagens, campanhas, e assim por diante).
  </Step>

  <Step title="Configure as variáveis">
    A coleção usa duas variáveis. Abra a coleção **Nuvia API**, vá até a aba **Variables** e
    preencha:

    | Variável        | Valor                                      |
    | --------------- | ------------------------------------------ |
    | `baseUrl`       | `https://api.nuvia.ai` (já vem preenchido) |
    | `NUVIA_API_KEY` | a sua API Key                              |

    Salve. Veja como gerar uma chave no [Guia de API Key](/guia-api-key).
  </Step>

  <Step title="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`.
  </Step>
</Steps>

## 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.

<Note>
  As requisições da pasta **auth** (login, recuperação de senha e OAuth) **não** usam a API Key —
  elas fazem parte do fluxo de autenticação e estão marcadas como *No Auth* na coleção.
</Note>

<Warning>
  A `NUVIA_API_KEY` é uma credencial sensível. Não compartilhe a coleção com o valor da variável
  preenchido, e prefira usar uma variável de **ambiente** do Postman em vez de salvar o valor
  direto na coleção.
</Warning>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Autenticação" icon="lock" href="/autenticacao">
    Como autenticar suas chamadas com uma API Key.
  </Card>

  <Card title="Exemplos de integração" icon="code" href="/guias/exemplos-integracao">
    Casos de uso completos com cURL, JavaScript e Python.
  </Card>
</CardGroup>