Documentação para LLMs

Esta página dá ao seu assistente de IA acesso direto à documentação da API UniSupri. Use uma das duas formas abaixo conforme seu fluxo.

Opção 1: Cole o link no seu LLM

Forma mais simples. Funciona em qualquer LLM que consegue abrir URLs. Cole um dos links abaixo e diga "estude esta documentação".

Pontos de entrada

TXT/llms.txtTXT/llms-full.txt
  • /llms.txt: índice no padrão llmstxt.org. Pequeno, lista todos os recursos. Comece por aqui.
  • /llms-full.txt: todos os guias concatenados num único arquivo. Ideal pra LLMs com janela grande.

Guias (markdown cru)

MD/guides/primeiros-passos.mdMD/guides/autenticacao.mdMD/guides/limites.mdMD/guides/midia.mdMD/guides/loja.mdMD/guides/produtos.mdMD/guides/produtos-precos.mdMD/guides/produtos-estoque.mdMD/guides/anuncios.mdMD/guides/anuncios-categorias.mdMD/guides/anuncios-atributos.mdMD/guides/anuncios-imagens.mdMD/guides/pedidos.mdMD/guides/pedidos-entrega.mdMD/guides/pedidos-retirada.mdMD/guides/pedidos-sob-encomenda.mdMD/guides/pedidos-industrializacao.mdMD/guides/pedidos-fiscal.mdMD/guides/pedidos-logistica.mdMD/guides/devolucoes.mdMD/guides/comunicacao.mdMD/guides/chat.mdMD/guides/perguntas.mdMD/guides/ocorrencias.md

OpenAPI completo

JSON/openapi.jsonYAML/openapi.yaml

OpenAPI por área

JSON/reference/primeiros-passos.jsonYAML/reference/primeiros-passos.yamlJSON/reference/loja.jsonYAML/reference/loja.yamlJSON/reference/produtos.jsonYAML/reference/produtos.yamlJSON/reference/anuncios.jsonYAML/reference/anuncios.yamlJSON/reference/pedidos.jsonYAML/reference/pedidos.yamlJSON/reference/devolucoes.jsonYAML/reference/devolucoes.yamlJSON/reference/comunicacao.jsonYAML/reference/comunicacao.yamlJSON/reference/ocorrencias.jsonYAML/reference/ocorrencias.yaml

Opção 2: Baixe o bundle

Pacote único com todos os guias e specs nos dois formatos (JSON e YAML). Útil pra rodar offline, embutir num RAG próprio, ou anexar em ferramenta que não busca URL.

DOWNLOADunisupri-api-docs-latest.tar.gzDOWNLOADunisupri-api-docs-latest.zip

Conteúdo do bundle:

README.md            instruções de uso
llms.txt             índice no padrão llmstxt.org
llms-full.txt        guias concatenados
guides/
  primeiros-passos.md, autenticacao.md, limites.md, midia.md
  loja.md
  produtos.md, produtos-precos.md, produtos-estoque.md
  anuncios.md
  pedidos.md, pedidos-industrializacao.md, pedidos-fiscal.md, pedidos-logistica.md
  devolucoes.md
  comunicacao.md, chat.md, perguntas.md
  ocorrencias.md
specs/
  openapi.json, openapi.yaml             (spec completo)
  <slug>.json, <slug>.yaml               (spec por área)

Prompt sugerido

Comece pelo prompt abaixo, adapte conforme sua tarefa:

Estude esta documentação: https://api-docs.samdevel.com.br/llms-full.txt

É a API REST do marketplace UniSupri. Quero implementar [DESCREVA A TAREFA].
Use os endpoints documentados e siga o envelope de resposta padrão
({ success, code, message_code, data, meta }).

Para detalhes técnicos de cada rota, consulte https://api-docs.samdevel.com.br/openapi.json

Dicas

  • LLMs com janela grande podem consumir o llms-full.txt direto.
  • LLMs com janela menor: cole o llms.txt primeiro. O LLM lê o índice e baixa apenas as páginas relevantes pela URL.
  • Cursor / Continue / Cline: aponte o agente pro llms-full.txt como contexto persistente do projeto.
  • RAG próprio: baixe o bundle e indexe os .md (chunks por seção) + os .json (paths/schemas individualmente).
  • Os arquivos são regenerados a cada deploy, sempre estarão na versão atual da API.

Compilado em 12/06/2026, 15:54.