Evolução das nossas APIs

Nosso ecossistema de APIs está passando por uma grande evolução. Sabemos que muitos desenvolvedores utilizam as APIs legadas disponíveis aqui no portal. Apesar de úteis, essas APIs foram criadas em um modelo antigo: sem documentação padronizada, com contratos genéricos e maior complexidade na integração.

Agora, apresentamos nossas novas APIs, construídas para oferecer a você uma experiência muito mais moderna, simples e eficiente.

O que muda?

• Padrão REST: endpoints claros, organizados e de fácil entendimento
• Contrato OpenAPI (Swagger): documentação completa, interativa e sempre atualizada
• Padronização de atributos: nomes consistentes e estruturados, evitando ambiguidades
• Exemplos práticos: cada endpoint conta com exemplos de requisição e resposta
• Melhor experiência para integradores: reduzindo tempo de desenvolvimento e manutenção

Por que migrar para as novas APIs?

• Menos esforço de integração: você entende rapidamente o que cada endpoint faz
• Mais confiabilidade: documentação oficial reduz erros de uso
• Futuro garantido: as APIs legadas estão em processo de descontinuação (sunset)
• Evolução contínua: novos recursos e melhorias serão disponibilizados apenas no novo modelo

O que vai acontecer com as APIs legadas?

As APIs legadas continuam funcionando por enquanto, mas não receberão novas funcionalidades nem correções evolutivas. Nosso plano é que, gradualmente, todas as integrações sejam migradas para o novo padrão.

Importante: em breve divulgaremos o cronograma oficial de sunset das APIs antigas.

Como começar?

• Acesse a documentação das novas APIs
• Explore os endpoints disponíveis e seus exemplos interativos
• Atualize suas integrações para o novo padrão REST
• Conte com nossa comunidade para tirar dúvidas ou apoiar sua migração

Estamos empolgados em dar este passo e temos certeza de que as novas APIs vão tornar sua experiência de desenvolvimento muito melhor!