Producto

Redesenhamos nossa API Reference: documentação feita por devs para devs

Redesenhamos nossa API Reference: documentação feita por devs para devs
Share

Na Pomelo, acreditamos que a melhor infraestrutura financeira é construída quando os times técnicos podem avançar sem fricções. Por isso, lançamos oficialmente nossa nova API Reference: um site completamente redesenhado, pensado para oferecer uma experiência moderna, clara e 100% orientada à autogestão técnica, permitindo integrar nossas soluções com mais rapidez e menos atrito.

A nova API Reference da Pomelo é um portal de documentação técnica redesenhado para facilitar a integração das nossas APIs por meio de busca global, assistente técnico com IA e suporte ao MCP Server. Este lançamento não é apenas uma atualização visual. É um salto de qualidade que acompanha nossa expansão regional e a evolução do nosso ecossistema de produtos.

Conheça abaixo tudo o que incorporamos à nossa API Reference.

Uma experiência renovada na nossa API Reference

Redesenhamos nossa API Reference do zero com um objetivo claro: tornar a integração com a Pomelo mais rápida, simples e previsível.

A nova página inicial funciona como um hub técnico central, a partir do qual é possível acessar rapidamente:

  • Categorias de APIs reorganizadas
  • Acesso direto ao MCP
  • Contato com um agente da Pomelo AI, disponível para responder dúvidas

Esses acessos otimizam a navegação: menos cliques, mais contexto e melhor orientação desde o primeiro minuto.

Além disso, cada seção da API Reference agora segue uma estrutura pensada para entender antes de implementar, com documentação mais clara, completa e consistente, incluindo:

  • Resumo conceitual
  • Descrição funcional
  • Lista completa de endpoints
  • Seção dedicada a webhooks
  • Exemplos consistentes e modelos padronizados

Integração mais inteligente: Pomelo AI + Busca global

Nossa API Reference agora incorpora a Pomelo AI, um assistente técnico conversacional projetado para acelerar e simplificar a integração.

A Pomelo AI:

  • Responde a perguntas específicas sobre a documentação
  • Explica fluxos, validações e parâmetros
  • Indica a fonte exata de onde extrai cada resposta

Também adicionamos um novo buscador global, capaz de encontrar endpoints e conceitos em segundos, com histórico de buscas recentes.

Uma camada de assistência inteligente que reduz bloqueios técnicos, acelera a integração e mantém rastreabilidade e precisão em cada resposta.

Apresentamos o MCP Server (Beta): integre usando linguagem natural

O Model Context Protocol (MCP) já está disponível na nossa documentação. Esse protocolo permite conectar-se às nossas APIs utilizando linguagem natural, a partir de ambientes como Cursor, VS Code ou Claude.

O objetivo é claro: integrar em segundos, sem precisar entender estruturas complexas ou escrever código do zero.

É um divisor de águas na experiência de integração e mais um passo em direção a uma infraestrutura verdadeiramente developer-first.

Convidamos você a testar a integração com nosso MCP no seu IDE favorito usando o seguinte prompt: “Quero me integrar às APIs da Pomelo” e ver como funciona na prática.

E muitas outras melhorias…

O site agora conta com modo escuro e uma interface refinada que torna a leitura, o escaneamento visual e o trabalho prolongado com código mais confortáveis.

Também desenvolvemos um novo Changelog para oferecer maior transparência. Com ele, nossos clientes poderão acompanhar:

  • Mudanças na API
  • Novas funcionalidades
  • Endpoints adicionados
  • Atualizações críticas
  • Próximos lançamentos

Tudo em um design mais moderno, claro e acessível.

Mais um passo rumo a uma experiência developer-first

Este redesign faz parte da nossa visão: construir a infraestrutura financeira mais clara, escalável e integrável da América Latina.

Sabemos que uma boa documentação técnica é fundamental para que nossos clientes lancem produtos mais rápido, com menos fricção e mais autonomia. A nova API Reference nos aproxima ainda mais desse objetivo.

Convidamos você a conhecer a nova API Reference da Pomelo.

SOBRE O AUTOR

Team Pomelo

Somos a equipe de especialistas no mercado financeiro que está por trás da voz, ou melhor, das Words da Pomelo. Contaremos tudo sobre o mercado, tendências, produtos, tecnologias, práticas recomendadas e histórias de pessoas do nosso time em primeira mão.

Ver mais artigos deste autor
Vamos conversar

Construa o produto
que o seu negócio
precisa.

Agende uma reunião com o nosso time.

Cecilia BrittoHead of Business
Alfonso TorreguitarHead of Global Solutions
Santiago WitisCountry Manager Cono Sur Latam
Jacob LevinCountry Manager México
Rafael GoulartCountry Manager Brasil
Paula BarnesHead of Risk
Emilia SerranoNew Businesses Director
Entre em contacto