API Docs Início Documentação Referência de API Copiar para LLM
Comece aqui

Downloads

Tudo o que dá para levar embora desta documentação: o contexto para LLM, as collections do Postman e a Referência de API em Markdown.

Os mesmos artefatos aparecem como botões no topo da visão geral de cada módulo — Consignado privado e FGTS. Esta página é o índice completo.

Contexto para LLM

Toda a documentação em arquivo de texto, gerado em runtime a partir das mesmas páginas que o portal serve: nunca fica defasado.

Arquivo O que traz Quando usar
llms-consignado-privado.txt Só o módulo Consignado privado: as nove páginas, na ordem do fluxo. Você vai integrar um produto. É o menor contexto que resolve.
llms-fgts.txt Só o módulo FGTS: as nove páginas, na ordem do fluxo. Idem, para o FGTS.
llms.txt Toda a documentação publicada, incluindo as páginas de Comece aqui. Você vai integrar os dois produtos, ou quer o contexto completo.

O arquivo completo também responde em /llms.txt, seguindo a convenção de mesmo nome.

Como usar

  1. Baixe o arquivo do módulo que você vai integrar.
  2. Coloque no contexto do seu assistente — anexo, @arquivo, ou colado, conforme a ferramenta.
  3. Descreva o que quer usando o nome de catálogo do produto: Consignado privado ou FGTS.

Prefira o arquivo do módulo ao completo. Contexto menor e específico reduz a chance de o assistente misturar regras de um produto com as do outro — e as regras divergem justamente nos pontos que mais custam: ordem dos cadastros, objeto de cálculo e forma do consentimento.

Não coloque token nem dado pessoal real no contexto do assistente. Os arquivos gerados aqui contêm apenas exemplos fictícios e mascarados.

Collections do Postman

Todas as collections usam as variáveis {{baseUrl}} e {{token}}, declaradas no nível da collection, com autorização Bearer {{token}} herdada por todas as requisições. Esquema Postman Collection v2.1.

Arquivo O que traz
uy3-consignado-privado.postman_collection.json Só o módulo Consignado privado: cadastros, operação e consultas.
uy3-fgts.postman_collection.json Só o módulo FGTS: cadastros, operação e consultas.
uy3-api-completa.postman_collection.json Os dois módulos, como pastas de primeiro nível.
uy3.postman_environment.json As mesmas variáveis, como environment em vez de variáveis de collection. token vem vazio e marcado como secreto.

Dentro de cada módulo, as pastas espelham a documentação: 1. Cadastros, 2. Operação, 3. Consultas — e, dentro delas, as requisições estão na ordem em que devem ser chamadas. No Consignado privado isso significa autorização de margem antes do cadastro do tomador, como na documentação.

Como importar

  1. No Postman: Import → File → selecione o arquivo baixado.
  2. Abra a collection → aba Variables e preencha baseUrl e token.
  3. Rode as requisições na ordem das pastas. As variáveis personId, bankAccountId, productId e creditNoteId vêm com valores fictícios: substitua pelos identificadores devolvidos pelas chamadas anteriores.

O passo a passo detalhado, incluindo o uso de environment em vez de variáveis de collection, está em Como importar no Postman.

Os dados de exemplo das collections são fictícios e mascarados. Nunca substitua por CPF, CNPJ, token ou chave reais em ambiente compartilhado, e nunca commite a collection depois de preencher token.

Referência de API em Markdown

Gerada do contrato OpenAPI, campo a campo:

API Markdown Página de cópia
Crédito creditapi/llm.md Copiar para LLM

A página Copiar para LLM permite copiar ou baixar a referência inteira, ou apenas uma etapa do fluxo. Ela é complementar ao contexto do módulo: o contexto traz a regra de negócio e a ordem; a referência traz o contrato campo a campo.

MCP

No ar. Este portal serve o servidor MCP da documentação na própria instância: o seu assistente consulta os guias e a Referência enquanto você escreve o código, em vez de você colar contexto a cada sessão. É somente leitura de documentação — nenhuma ferramenta chama a API da UY3 nem recebe credencial.

Arquivo O que traz
.mcp.json Configuração do cliente, com o endereço desta instância já preenchido. Salve na raiz do seu projeto.

O passo a passo por cliente (Claude Code, Cursor, VS Code) está em Integração via MCP; o estado do servidor, em Servidor MCP — estado.

O contexto para LLM do módulo continua valendo para quando o assistente não fala MCP, ou quando você quer levar o contexto para fora.

Antes desta etapa

Próxima etapa