Postman e IA
Dois atalhos para integrar mais rápido: uma collection pronta para testar no Postman e a documentação inteira em um único Markdown, feito para agentes de IA.
Collection do Postman
Todos os endpoints de /v1, com corpos de exemplo, respostas de exemplo e a autenticação já configurada. A baseUrl sai preenchida com a URL desta instalação.
No Postman, use Import e arraste o arquivo, ou cole a URL /postman-collection.json desta documentação. Depois, abra a aba Variables da collection e preencha apiKey.
Variáveis da collection
baseUrlstringopcional | URL da API, sem o /v1. Já vem preenchida. |
apiKeystringobrigatório | Chave gerada em Configurações, API, na dashboard. Vai no header x-api-key. |
chargeIduuidopcional | Preenchida sozinha por "Criar cobrança". Usada em "Consultar cobrança". |
payoutIduuidopcional | Preenchida sozinha por "Criar transferência". Usada em "Consultar transferência". |
webhookIduuidopcional | Preenchida sozinha por "Criar endpoint". Usada em atualizar e remover. |
Idempotency-Key novo a cada envio ({{$guid}}), então clicar duas vezes cria dois recursos.Documentação para IA
Agentes de IA e ferramentas de geração de código leem melhor um arquivo de texto do que páginas HTML com navegação. Por isso a documentação inteira também existe em Markdown, em um único arquivo: autenticação, idempotência, paginação, erros, todos os endpoints com campos e exemplos, eventos de webhook e validação de assinatura.
Arquivos
/ai.mdtext/markdownopcional | A documentação completa, com um resumo para agentes no topo e uma receita de integração passo a passo no fim. |
/llms.txttext/plainopcional | Índice curto no padrão llms.txt, que ferramentas de IA procuram na raiz do site. Aponta para o ai.md e para a collection. |
/postman-collection.jsonapplication/jsonopcional | Collection do Postman v2.1. Também serve como especificação estruturada dos endpoints. |
Usando com um assistente
Passe a URL do Markdown para o assistente e descreva o que quer integrar. Um ponto de partida:
Leia a documentação da API em <URL desta documentação>/ai.md.
Implemente no meu backend:
1. criação de cobrança Pix para um pedido, usando o id do pedido
como Idempotency-Key e como reference;
2. um endpoint de webhook que valide X-Webhook-Signature sobre o
corpo cru e dê baixa no pedido em charge.pix.paid.
A chave da API vem de process.env.API_KEY.