Skip to main content
A GoatPay publica um índice otimizado para LLMs e assistentes de código. Com ele, Cursor, Claude, ChatGPT e agentes autônomos conseguem gerar integrações corretas sem adivinhar rotas ou formatos.

​
Arquivos disponíveis

RecursoURLQuando usar
llms.txtdocs.goatpay.com.br/llms.txtVisão geral, mapa de rotas, convenções
OpenAPIdocs.goatpay.com.br/openapi.yamlSchemas, tipos e playground
Páginas .mdQualquer doc + .md no final da URLDetalhe de um endpoint ou guia
O llms.txt resume autenticação (X-API-Key: gp_live_...), envelope de resposta, módulos (PIX, cripto, conta, loja, subcontas) e o que não está no escopo v1.

​
Cursor

​
Adicionar como documentação (@Docs)

  1. Cursor Settings → Indexing & Docs → Add new doc
  2. URL: https://docs.goatpay.com.br/llms.txt
  3. Opcional: adicione também https://docs.goatpay.com.br/openapi.yaml
No chat, referencie com @Docs ou cole o link do endpoint específico.

​
Exemplo de prompt

@Docs Integre a GoatPay no meu backend Node.js:
1. Criar cobrança PIX com externalReference
2. Endpoint POST /webhook que valida x-goatpay-signature (HMAC-SHA256)
3. Marcar pedido como pago no evento payment.paid

Use X-API-Key, base https://api.goatpay.com.br/v1 e o envelope { success, data, requestId }.

​
Regras do projeto (.cursor/rules)

Crie uma regra curta no repositório do integrador: 
# GoatPay API
- Base: https://api.goatpay.com.br/v1
- Auth: header X-API-Key (gp_live_...)
- Respostas: envelope JSON com success, message, data, requestId
- Webhooks: validar x-goatpay-signature no raw body com whsec_
- Docs: https://docs.goatpay.com.br/llms.txt
- OpenAPI: https://docs.goatpay.com.br/openapi.yaml

​
Claude (Projects)

  1. Crie um Project para sua integração GoatPay
  2. Em Project knowledge, adicione:
    • https://docs.goatpay.com.br/llms.txt
    • openapi.yaml (baixe ou use URL)
  3. Nas instruções do projeto, inclua:
Sempre consulte a documentação GoatPay antes de sugerir rotas.
Trilho PADRAO vem da API key, não do body.
Não invente campos provider, accountId ou metadata — não existem na API pública.

​
ChatGPT e outros

  • Custom instructions / GPT: cole o conteúdo de llms.txt ou aponte a URL
  • API / Agents: busque llms.txt no início da sessão e mantenha openapi.yaml para schemas
  • MCP: se o servidor suportar fetch de URL, registre docs.goatpay.com.br/llms.txt como fonte

​
O que pedir à IA (e o que evitar)

​
Boas práticas

FaçaPor quê
Cite externalReference em cobrançasReconciliação com seu ERP
Valide webhook no raw bodyRe-serializar JSON quebra o HMAC
Use permissões mínimas na chaveSegurança e princípio do menor privilégio
Aponte para o guia de webhooksEventos e retentativas oficiais
Confirme verificação KYC aprovadaReembolso e MED exigem conta verificada

​
Evite

Não façaMotivo
Polling agressivo em GET /payment-pix/getUse webhooks; rate limit 100/min
Assumir sandboxSó produção; teste com valores baixos
Enviar pixRail no bodyTrilho vem da API key
Documentar rotas fora do llms.txt v1Boleto, assinaturas, bureau = doc futura

​
Fluxo sugerido para agentes

  1. Leia llms.txt para escopo e convenções
  2. Abra o guia do módulo (ex. /api-reference/guides/pix.md)
  3. Use openapi.yaml para tipos de request/response
  4. Gere código e teste com valor baixo

llms.txt

Índice para LLMs

OpenAPI

Contrato completo

Primeira integração

Tutorial hands-on

Troubleshooting

Erros comuns