Introdução

A inteligência artificial está rapidamente se tornando uma parceira essencial no desenvolvimento de software, não apenas nos códigos que escrevemos, mas também na maneira como consumimos e mantemos a documentação técnica. Este guia foi criado para mostrar, passo a passo, como aproveitar os recursos de Ask AI e do arquivo llms.txt para turbinar o seu fluxo de trabalho com as APIs da CrediPay. Aqui você encontrará boas práticas, prompts prontos para uso e um caso prático completo que ilustra como integrar compradores, pedidos e faturamento em um ERP sem escrever uma linha de código. Use-o como ponto de partida, adapte-o às necessidades do seu projeto e descubra como a IA pode transformar tarefas repetitivas em processos rápidos, precisos e colaborativos.

IA na documentação

Ask AI

Em todas as páginas da nossa documentação agora é possível usar a funcionalidade de 'Ask AI'. Através dela, você consegue abrir uma conversa com os principais LLMs do mercado, através dos quais você pode tirar dúvidas e pedir trechos de códigos. Ademais, é possível também acessar o markdown da página, o que é especialmente útil para inserção em IDE's como Cursor e Windsurf.

llms.txt

Para inserir a documentação como um todo em seu ambiente de desenvolvimento, você deve acessar https://docs.credipay.credix.finance/llms.txt , copiar e colar o texto. Vale ressaltar que também é possível (e recomendado) que seja colado apenas o conteúdo das páginas que se apliquem à parte que você esteja desenvolvendo no momento, visando deixar o contexto do seu modelo mais assertivo.

Caso prático

Nesta seção, compartilharemos alguns prompts úteis para realizar uma implementação básica das APIs da CrediPay em um ERP. O objetivo é integrar os módulos de compradores, pedidos e faturamento do ERP às APIs do CrediPay sem usar código.

Neste projeto, usaremos o Cursor, porém as técnicas utilizadas aqui podem ser facilmente replicadas em outras ferramentas. Vale ressaltar que os prompts utilizados neste processo não devem ser estritamente copiados em seu ambiente, mas podem servir como referência para os seus próprios prompts.

Passo 0: Configurar variáveis de ambiente

Antes de começar, é necessário configurar as variáveis de ambiente. Para o desenvolvimento em questão, precisaremos de:

CREDIPAY_API_KEY -> A chave de API da CrediPay
CREDIPAY_API_URL -> A URL base do ambiente

Para mais informações, leia Autenticação e ambientes

Passo 1: Compradores

Como ponto de partida, temos uma página de compradores, onde o usuário pode selecionar um CNPJ e visualizar algumas informações básicas

O que queremos aqui é puxar o limite de crédito da CrediPay e disponibilizá-lo para o usuário no frontend. Para isso, enviaremos os prompts abaixo:

Prompt 1.1: Criando o serviço

Vamos começar a construir uma integração com a API da CrediPay. O primeiro passo que devemos construir é uma chamada do nosso server para a API GET v2/buyers da CrediPay (https://docs.credipay.credix.finance/reference/buyerscontroller_getbuyers.md ). Certifique-se de autenticar corretamente (https://docs.credipay.credix.finance/docs/api-usage-authentication.md ). A Chave de API (CREDIPAY_API_KEY) e o URL base (CREDIPAY_API_URL) já estão configuradas como variáveis de ambiente.

Prompt 1.2: Ajustando o frontend

Usando o que construimos, exponha o limite de crédito disponível na CrediPay para o CNPJ escolhido em @page.tsx

Com estes dois prompts, nossa IA já foi capaz de realizar os ajustes necessários e trazer os dados da CrediPay para o frontend do nosso ERP!

Passo 2: Pedidos

Nosso ERP possui também uma tela para criação de pedidos. Nela, podemos escolher o comprador, inserir o endereço de entrega, forma de pagamento, etc. Nosso objetivo agora é permitir que o usuário crie um pedido utilizando o limite de crédito CrediPay.

Forma de pagamento

O primeiro passo é habilitar o sistema a oferecer a forma de pagamento CrediPay. Para isso, podemos enviar os seguintes prompt:

Prompt 2.1: Nova forma de pagamento

Atualize minha lista de formas de pagamento e inclua a forma CrediPay. Ela deve permitir que o usuário escolha opções de pagamento em 1, 2 ou 3 vezes. Reflita esta mudança também na página de criação de pedidos ( @page.tsx )

Como resultado, agora podemos escolher a forma de pagamento CrediPay

Exibindo e checando o limite de crédito disponível

É importante que o limite de crédito disponível do comprador também seja exibido na tela de criação de pedidos, para que o usuário saiba o quanto pode inserir nesse pedido.

Prompt 2.2: Limite de crédito na página de pedidos

Na página de criação de pedidos @NewOrderPage() use nosso serviço @credipay.ts para exibir o limite de crédito disponível da CrediPay após o usuário selecionar um comprador. Se o comprador nao for encontrado na CrediPay, exiba 0

Com isso, agora conseguimos checar o limite de crédito quando selecionamos um comprador.

Também é importante assegurar que a opção de pagar com CrediPay não possa ser seleciona caso não haja limite suficiente. Para isso, podemos rodar o prompt:

Prompt 2.3: Bloqueando CrediPay caso não haja limite

Ajuste o formulário de criação de pedido @OrderForm.tsx para que o usuário só possa selecionar a opção CrediPay caso o valor total do pedido seja menor ou igual ao limite de crédito disponível com a CrediPay

E como resultado, a partir da agora não conseguiremos mais optar por transacionar com CrediPay caso não haja limite:

Enviando o pedido para a CrediPay

Agora, precisamos nos assegurar que, assim que o usuário submeter o pedido, ele será enviado à CrediPay para que seja realizada a reserva de limite de crédito. Além disso, devemos nos assegurar de que o pedido não será criado internamente caso não seja aceito pela CrediPay - nesse caso, o usuário também deve ser informado da recusa.

Para isso, o primeiro passo é integrar o endpoint de criação de pedidos:

Prompt 2.4: Implementando o endpoint de pedidos

Na nossa integracao com a credipay @credipay.ts , implemente agora o endpoint de criacao de pedidos @https://docs.credipay.credix.finance/reference/orderscontroller_postorder.md . Certifique-se de autenticar corretamente @https://docs.credipay.credix.finance/docs/api-usage-authentication.md .

Em seguida aplicar ao nosso fluxo:

Prompt 2.5: Integrando endpoint de pedidos no fluxo

Usando o que acabamos de construir, ajuste a criação de pedidos @handleCreateOrder() para primeiro tentar criar o pedido na CrediPay. Se houver um erro, mostrar ao usuário na @NewOrderPage() . Se bem sucedido, criar um pedido na base de dados, já com o order id da CrediPay - nao devemos criar um pedido na base de dados caso nao seja criado na CrediPay

Prompt 2.6: Exibindo o id do pedido no frontend

Exiba o order id da credipay na pagina do pedido @OrderDetailPage()

E pronto! De agora em diante, o pedido será criado automaticamente na CrediPay, e veremos o id CrediPay em nosso frontend:

Passo 3: Faturamento

A última etapa a ser integrada é a de faturamento. Como nosso ERP demonstrativo não tem a capacidade de emitir uma NF real, nós vamos realizar uma simulação por meio de um upload de XML, e assim enviar o XML para a CrediPay.

Como de costume, vamos começar integrando o endpoint para captura do XML:

Prompt 3.1: Implementando endpoint de captura de XML

Na nossa integracao com a credipay @credipay.ts , implemente agora o endpoint de captura de xmls @https://docs.credipay.credix.finance/reference/orderscontroller_captureorder.md . Certifique-se de autenticar corretamente (@https://docs.credipay.credix.finance/docs/api-usage-authentication.md ) Tenha em mente que:

O id do pedido enviado no URL é o ID do pedido na CrediPay
Content Type deve ser multipart form data

Em seguida aplicar ao nosso fluxo

Prompt 3.2: Integrando endpoint de captura de XML ao nosso fluxo

Usando o que acabamos de construir, ajuste a criação de notas fiscais @handleUpload() para primeiro tentar criar o pedido na CrediPay. Certifique-se de passar o order id da CrediPay e nao o order id interno do sistema. Se houver um erro, mostrar ao usuário na @UploadInvoicePage() . Se bem sucedido, atualizar o pedido na base de dados, com os dados do arquivo - nao devemos atualizar o pedido na base de dados caso o xml nao seja aceito pela CrediPay.

Com isso, o fluxo se torna completamente integrado, e toda vez que tivermos um novo XML de Nota Fiscal, ele será enviado à CrediPay. Quando um XML é enviado e aceito, a CrediPay considera a transação oficializada, e partir deste momento irá formalizar legalmente a operação, emitir os boletos para cobrança, e provisionar o montante para desembolso ao vendedor.

A partir daqui, não há mais nenhuma ação mandatória por parte do vendedor, ou seja, a integração está completa!

Conclusão

A funcionalidade Ask AI e o arquivo llms.txt transformam a maneira como você consome a documentação da CrediPay: a primeira cria um canal direto com os principais modelos de linguagem para tirar dúvidas e gerar código sob demanda; o segundo leva todo o conteúdo (ou apenas as páginas relevantes) para dentro da sua IDE, oferecendo contexto instantâneo aos seus prompts. Com isso, o processo de leitura, compreensão e aplicação da documentação fica muito mais rápido e preciso, reduzindo retrabalho e acelerando o ciclo de desenvolvimento.

O caso prático mostrou como, guiado por prompts bem-estruturados, é possível integrar módulos de compradores, pedidos e faturamento em um ERP sem escrever código manual: desde configurar variáveis de ambiente e exibir limites de crédito, até criar pedidos condicionados ao limite e capturar XML de notas fiscais. Ao adotar esse fluxo orientado por IA, você automatiza tarefas repetitivas, garante consistência entre sistemas e libera tempo para focar em soluções criativas que agreguem valor ao produto.