Contratos e referência OpenAPI

Cada produto mantém sua própria documentação e evolui endpoints de forma independente. O arquivo disponível aqui é um índice inicial de rotas confirmadas, não uma especificação oficial completa nem substituto para os portais dos produtos.

Fontes de verdade

  • allPost — referência por módulos, parâmetros, limites e respostas.
  • SellerPay — pedidos, ciclos, fila, autenticação e webhooks.
  • HelpyGo — autenticação, agentes, pedidos, fila e webhooks.
  • Precode — Explorer das versões 1, 2 e 3.
  • Portal do Seller — referência da API v2 com schemas.

Download do índice

O YAML reúne URLs base, esquemas de autenticação e algumas operações confirmadas para facilitar a descoberta em editores compatíveis.

Baixar ecossistema-precode-openapi.yaml

Antes de gerar clientes ou publicar uma integração, confirme parâmetros, campos obrigatórios e respostas na documentação oficial do produto.

Trecho do arquivo

openapi: "3.0.3"
info:
  title: "Índice das APIs do Ecossistema Precode"
  version: "2026-09"
paths:
  /api/v1/filial:
    get:
      summary: "Consulta a filial no allPost ou SellerPay"
  /v2/products:
    get:
      summary: "Lista produtos no Portal do Seller"

Próximos passos

Para testar as rotas com ambientes separados, use a coleção Postman.