Para IA
Entregue esta documentação inteira ao seu agente de IA em arquivos de texto e OpenAPI, sem raspar HTML, ou pergunte sobre ela sem sair da página.
Arquivos para o seu agente
Os caminhos são relativos ao endereço desta documentação. Em <produto>, use pix, conta, gateway, recorrencia, cambio ou onboarding.
| Arquivo | O que contém | Quando usar |
|---|---|---|
/llms.txt | Índice de toda a documentação: título, link e descrição de cada guia e de cada rota | Para o agente descobrir onde está cada assunto |
/llms-full.txt | Texto completo de todos os guias | Integração com mais de um produto |
/<produto>/llms.txt | Índice de um produto só | Integração de um produto, para o agente achar a página certa |
/<produto>/llms-full.txt | Texto completo dos guias de um produto | Integração de um produto: o arquivo é menor e não mistura reais com centavos |
/openapi/pix.json, /openapi/account-hub.json, /openapi/gateway.json | Contrato das rotas do PayZu Pix, do PayZu Conta Hub e do PayZu Gateway (API e checkout) | Gerar cliente, validar payload, dar ao agente os campos e tipos exatos |
/openapi/payments.json | Contrato das APIs de cartão: PayZu Payments e recorrência no cartão | O mesmo, para as APIs de cartão |
/openapi/onboarding.yaml | Contrato das rotas do PayZu Onboarding | O mesmo, para a abertura de contas |
O contrato nesses arquivos é o mesmo da referência. O PayZu Pix também tem SDKs prontos, e cada produto tem uma coleção do Postman; os dois ficam nas abas SDKs e Coleção do Postman do produto.
Entregue ao agente o OpenAPI e o llms-full.txt do produto.
O OpenAPI acerta nomes de campo e formatos, mas não traz o que só os guias explicam: unidade de valor, prazos, idempotência e fluxo de callbacks.
Na referência
| Recurso | Onde | O que faz |
|---|---|---|
| Copiar página | Botão no alto de cada rota da referência | Copia a rota em Markdown: método e caminho, credencial, parâmetros, respostas com exemplo e o código de exemplo |
| Perguntar à IA sobre esta página | Menu ao lado do botão de copiar | Abre o painel Perguntar à IA com a rota atual como contexto |
| Perguntar à IA | Aba no topo da documentação e botão no canto inferior direito | Responde com base nesta documentação e sugere perguntas comuns |
Cole o Markdown copiado no seu assistente quando quiser que ele implemente ou revise a chamada de uma rota específica.