Como importar no Postman

Este guia mostra como testar qualquer endpoint das APIs UY3 no Postman (ou no terminal) sem edição manual — bastando trocar dois placeholders. A convenção vale para toda a Referência de API.

Convenção de placeholders

Todos os exemplos usam os mesmos dois placeholders, compatíveis com variáveis de environment do Postman:

Nunca coloque o token na URL ou em query string. A credencial vai sempre no header Authorization. Trate o token como segredo.

1. Criar o environment (uma vez)

1. No Postman, abra Environments → Create Environment.
2. Nomeie como UY3 — Homologação (ou o ambiente desejado).
3. Adicione duas variáveis:
   • baseUrl → a URL base da API que você recebeu no onboarding.
   • token → o JWT atual (veja Autenticação).
4. Selecione esse environment no seletor no canto superior direito.

Com isso, {{baseUrl}} e {{token}} são resolvidos automaticamente em qualquer requisição.

2. Importar a collection do módulo (Import > File)

O caminho mais curto: em vez de importar endpoint por endpoint, baixe a collection pronta do produto que você vai integrar.

1. Baixe o arquivo em Downloads, ou pelo botão na visão geral do módulo — Consignado privado ou FGTS.
2. No Postman: Import → File → selecione o arquivo.
3. Abra a collection → aba Variables e preencha baseUrl e token. A autorização Bearer {{token}} já vem configurada no nível da collection.
4. Rode as requisições na ordem das pastas: 1. Cadastros, 2. Operação, 3. Consultas. A ordem dentro de cada pasta é a ordem em que as chamadas devem ser feitas.

As collections trazem também as variáveis personId, bankAccountId, productId e creditNoteId, com valores fictícios. Substitua cada uma pelo identificador devolvido pela chamada anterior — é o que faz o fluxo andar de ponta a ponta sem editar URL.

Se você preencher token na collection, não commite o arquivo. Para trabalho em equipe, prefira o environment do passo 1: ele fica na sua máquina, a collection é compartilhável.

3. Importar um endpoint pelo cURL (Import > Raw text)

Cada página de endpoint na Referência de API traz um bloco cURL pronto. Para levar ao Postman:

1. Na página do endpoint, clique em Copiar no bloco cURL.
2. No Postman, clique em Import → aba Raw text.
3. Cole o cURL e confirme (Continue → Import).
4. O Postman cria a requisição com método, URL, headers e body já preenchidos. Selecione o environment e clique em Send.

O mesmo bloco funciona colado direto no terminal (com curl instalado), trocando os placeholders por valores reais.

4. Autorização no nível da Collection

Para não repetir o header em cada requisição, configure a autorização uma vez:

1. Abra a Collection → aba Authorization.
2. Type: Bearer Token.
3. Token: {{token}}.
4. Deixe as requisições como Inherit auth from parent.

Levar a referência inteira para uma LLM

Precisa de todo o contexto de um produto de uma vez, para gerar código ou tirar dúvidas? Baixe o contexto para LLM do módulo em Downloads — ele traz as páginas do produto na ordem do fluxo, com a regra de negócio de cada etapa. Para o contrato campo a campo, use Copiar para LLM na Referência de API.

Checklist rápido

• Environment com baseUrl e token criado e selecionado.
• Collection do módulo importada via Import > File.
• Endpoint importado via Import > Raw text (cURL).
• Authorization Bearer {{token}} no nível da Collection.
• Send retornando 200/201 (ou 202 para fluxos assíncronos).

Precisa do token? Veja Autenticação e Primeiros passos.