Integre com agentes de IA
Como apontar Claude, ChatGPT, Cursor ou qualquer assistente de código para esta documentação, e as regras que ele precisa seguir para gerar uma integração segura.
Esta documentação é publicada para ser lida por pessoas e por modelos de linguagem. Todo o conteúdo existe também em Markdown limpo, sem menu, rodapé ou scripts, e o contrato da API está em OpenAPI 3.1. Um agente que parte desses arquivos escreve a integração com menos suposições e menos alucinação.
O que está disponível
| Endereço | Conteúdo | Quando usar |
|---|---|---|
/llms.txt | Índice curado, no formato llmstxt.org: fatos gerais da API e um link por página, com descrição. | Ponto de partida. Cabe em qualquer janela de contexto. |
/llms-full.txt | A documentação inteira em um único arquivo Markdown. | Quando o agente precisa de tudo de uma vez, por exemplo para revisar uma integração completa. |
/docs/<página>.md | Qualquer página em Markdown. Acrescente .md à URL que está no navegador: /docs/pix/criar-cobranca vira /docs/pix/criar-cobranca.md. | Para dar ao agente só o trecho relevante. |
/openapi.yaml e /openapi.json | Contrato OpenAPI 3.1: rotas, campos, enums, exemplos e erros. | Para gerar clientes, tipos e validações. |
Em cada página há também os botões Copiar como Markdown e Abrir em, que levam a página direto para o ChatGPT, o Claude ou o Cursor.
Como usar no seu assistente
Peça para o agente ler o índice antes de escrever código. Ele segue os links de que precisar:
Leia https://docs.accelerazione.com.br/llms.txt e implemente no nosso backend a criação de
cobrança Pix e o endpoint que recebe o webhook, validando a assinatura HMAC.Para que a regra valha em todas as sessões, copie o bloco da seção Instruções para o seu repositório para o CLAUDE.md do projeto.
Os endereços acima usam o domínio público da documentação. Se você recebeu a documentação por outro endereço, troque o domínio e mantenha o caminho.
Instruções para o seu repositório
Agentes de código leem arquivos como AGENTS.md, CLAUDE.md ou .cursor/rules na raiz do projeto. Copie o bloco abaixo para o arquivo que o seu agente usa. São as regras que mais evitam erro em integrações de pagamento.
## Integração Accelerazione
Documentação: https://docs.accelerazione.com.br/llms.txt (Markdown de cada página: acrescente .md à URL).
Contrato: https://docs.accelerazione.com.br/openapi.yaml
Regras:
- A chave de API vai só no servidor, no cabeçalho `Authorization`, sem prefixo `Bearer`.
Nunca em código de navegador, app mobile, log ou repositório.
- Valores são inteiros em centavos em toda a API (cobranças, saques, extrato): R$ 19,90 é `1990`. Nunca envie decimal.
- Toda criação de cobrança envia `Idempotency-Key` única por tentativa, gravada antes da chamada.
Em falha de rede, repita com a mesma chave e o mesmo corpo.
- O pedido só é considerado pago com `status: "Succeeded"`, lido por webhook com assinatura
válida ou por `GET /api/v1/paymentintents/{id}`. QR Code exibido, iframe 3DS fechado ou
retorno do comprador ao site não são prova de pagamento.
- O webhook valida `X-DM-Signature` (HMAC-SHA256 de `timestamp + "." + corpo cru`) com
comparação em tempo constante, grava o evento e só então responde 200.
- Trate eventos repetidos e fora de ordem: deduplique por `X-DM-Webhook-Id` e nunca
regrida um pedido já confirmado ou estornado.
- Estorno é integral e assíncrono: `202` significa pedido aceito, não dinheiro devolvido.
- Desenvolva e teste no sandbox. Não use dados reais de cartão em testes.Boas perguntas para fazer ao agente
Agentes acertam mais quando a tarefa cita o caso infeliz. Alguns pedidos que funcionam bem:
- "Implemente o webhook da Accelerazione de forma idempotente, cobrindo evento repetido, evento fora de ordem e evento que chega antes da resposta do create."
- "Escreva testes para os quatro desfechos da criação de cobrança com cartão:
Succeeded,Failed,ProcessingeRequiresAction." - "Revise nossa integração contra o checklist de homologação e liste o que falta."
O que o agente não deve inventar
Se o agente sugerir algo que não está nesta documentação, desconfie. Em particular, a API não tem:
- captura manual, cancelamento de cobrança ou estorno parcial por chamada própria;
- webhook de expiração, de cancelamento ou de desafio 3DS;
- autenticação por
Bearerou pormerchantIdno corpo da cobrança.
Quando a documentação não responder, fale com a equipe de integração da Accelerazione em vez de deixar o agente supor.