Como funciona a integração com a API da CN Pay
API White Label no domínio do seu gateway
Quando você contrata a CN Pay, sua plataforma passa a rodar em um domínio próprio, por exemplo:
https://app.seugateway.com
Nesse mesmo domínio, disponibilizamos automaticamente uma documentação completa da API, acessível no caminho:
/docs
Exemplo:
https://app.seugateway.com/docs
Essa documentação é padronizada, sempre atualizada e já preparada para ser usada tanto por desenvolvedores quanto por ferramentas de Inteligência Artificial.
Você também pode acessar a documentação diretamente pelo painel admin, clicando no ícone de perfil e, em seguida, na opção "Documentação".
Ou no acesso de produtor, clicando no ícone de perfil e, em seguida, na opção "Documentação API".
Quem usa essa API?
A API do seu gateway pode ser utilizada por:
Plataformas de e-commerce
Sistemas próprios dos produtores
Aplicações web ou mobile
Ferramentas de automação
Plataformas de IA e low-code
Ou seja, qualquer sistema que precise criar pagamentos, consultar transações, receber webhooks ou automatizar operações financeiras no painel de produtor.
O que é possível fazer via API?
Por meio da API White Label da CN Pay, é possível, por exemplo:
Criar pagamentos via PIX, boleto ou cartão
Consultar transações
Consultar saldos
Realizar transferências
Receber notificações via webhook
Integrar splits de pagamento
Automatizar fluxos financeiros
Tudo isso respeitando as regras e configurações do seu gateway.
Documentação clara e centralizada
A página /docs reúne todas as informações necessárias para a integração, como:
Endpoints disponíveis
Métodos (POST, GET, etc.)
Campos obrigatórios e opcionais
Tipos de dados
Exemplos de requisição e resposta
Tratamento de erros
Autenticação via chaves de API
Isso permite que seus clientes consigam integrar sem depender diretamente do seu time técnico.
Autenticação da API
Todas as requisições à API exigem autenticação, feita através de chaves específicas.
Cada cliente que irá integrar recebe:
Chave pública
Chave secreta
Essas chaves são geradas em: Painel de produtor -> Integrações -> API.
E devem ser enviadas nos headers das requisições e identificam exatamente qual conta está realizando a operação dentro do seu gateway.
Integração tradicional (manual)
No modelo tradicional, o desenvolvedor do cliente:
Acessa a documentação em
/docsEscolhe o endpoint desejado (ex: Receber PIX)
Implementa o código manualmente no sistema dele
Testa as requisições
Coloca em produção
Esse fluxo continua totalmente suportado e documentado.
Integração assistida por Inteligência Artificial
Além da integração manual, a CN Pay oferece uma página dedicada à integração via IA, pensada para acelerar o desenvolvimento.
Essa funcionalidade é ideal para:
Clientes com pouco time técnico
Startups em fase inicial
Desenvolvedores que querem ganhar velocidade
Ferramentas como ChatGPT, Claude, Cursor, Lovable, Bolt, entre outras
Como funciona a integração via IA
Em cada página de endpoint da documentação, existe o botão:
“Integrar com IA”
Ao clicar nesse botão:
Um conjunto de instruções estruturadas é copiado
Esse conteúdo já vem formatado para ser entendido por ferramentas de IA
Inclui todas as informações necessárias do endpoint
Essas instruções podem ser coladas diretamente na ferramenta de IA escolhida.
O que a IA recebe nessas instruções?
As instruções copiadas incluem:
Método e URL do endpoint
Forma correta de autenticação
Campos obrigatórios e opcionais
Tipos de dados
Estrutura de resposta
Exemplos de requisição e retorno
Possíveis erros
Com isso, a IA consegue gerar código funcional e alinhado à API do seu gateway.
Exemplo prático de uso
Após copiar as instruções de um endpoint, o cliente pode complementar o prompt com informações como:
Linguagem de programação
Framework utilizado
Biblioteca HTTP
Requisitos específicos do projeto
A partir disso, a IA gera o código base da integração, que pode ser ajustado e refinado conforme a necessidade.
Boas práticas importantes
Mesmo com o uso de IA, é importante reforçar que:
O código gerado deve ser revisado
As credenciais reais nunca devem ser coladas na IA
O ideal é usar placeholders e substituir depois
Testes devem ser feitos antes de produção
A IA acelera o processo, mas a validação final é sempre responsabilidade do integrador.
Resumo final
A integração com a API de produtor da CN Pay foi pensada para ser:
White Label
Simples de entender
Flexível para diferentes tipos de clientes
Compatível com integrações manuais e via IA
Com a documentação disponível no domínio do seu gateway e o suporte à integração assistida por Inteligência Artificial, seus clientes conseguem integrar mais rápido, com menos erros e menos dependência do seu suporte técnico.