📘

Roadmap

Consulte nosso roadmap para acompanhar nossos próximos lançamentos.

Introdução

Sabemos que integrar e manter sua aplicação atualizada com diversas APIs nem sempre é uma tarefa fácil. Por esse motivo, queremos tornar esse processo o mais previsível e estável possível, de forma a transparecer quais aspectos são necessários para a integração com as nossas APIs. Assim, disponibilizamos este material para que você consiga se programar e garantir uma transição suave e fluida para as nossas próximas versões.

Ciclo de vida

Fases

Planejamento

É nesta fase que conversamos sobre a próxima versão que será disponibilizada. Refletimos com cuidado no impacto de cada alteração para que você seja minimamente afetado a fim de que a experiência de integração, manutenção e utilização seja a mais agradável possível. Alguns dos pontos que sempre consideramos são:

• Experiência de uso;
• Segurança;
• Confiabilidade;
• Manutenibilidade;
• Performance;
• Documentação.

Dado que esta é uma fase de planejamento, não é comum comunicarmos externamente quando uma nova versão está sendo discutida, mas saiba que, se uma versão foi lançada, muito provavelmente a próxima já está sendo desenhada.

Desenvolvimento

É nesta fase que desenvolvemos a próxima versão a ser lançada, considerando sempre a melhor combinação entre requisitos funcionais e não-funcionais. Nosso processo de desenvolvimento foi criado para que todas as entregas realizadas sejam sempre revisadas, verificadas e validadas ainda em tempo de desenvolvimento. Se algum problema é identificado durante uma das etapas, o item é retornado para correção antes de ser liberado na versão.

Lançamento

Depois de tudo pronto, é neste estágio que preparamos o lançamento da nova versão. Para tal, seguimos um extenso checklist para garantir que todas as atividades necessárias foram executadas da forma correta para corresponder às alterações realizadas:

• Documentação externa:
  • Manual de Produto: o manual de produto foi atualizado?
  • Referência Técnica (swaggers);
  • FAQ;
  • Base de Conhecimento;
  • Política de Privacidade;
  • Termos e Condições de Uso;
  • Apresentações comerciais;
• Dashboards de monitoração;
• Configuração dos Ambientes:
  • Desenvolvimento;
  • Homologação;
  • Sandbox; e
  • Produção;
• Treinamentos internos;
• Estratégia de comunicação:
  • Site institucional;
  • Comunicados;
• Análise do contrato padrão;
• Análise de precificação.

Sustentação

Neste ponto a versão já está disponível em nossos ambientes para ser utilizada por todos os clientes.

👍

Fique tranquilo(a)!

Nossa equipe sempre avisará quando uma nova versão estiver disponível. Se preferir, você pode acessar nosso Repositório de Comunicados.

Sunsetting

Versões nesta fase estão em via de serem descontinuadas, portanto se for o caso da que você está utilizando, é importante se programar para substituí-la pela versão mais recente o quanto antes. Por isso, aproveite este período para garantir uma transição mais suave.

Como dito anteriormente, nosso intuito é permitir que quaisquer atualizações de versão sejam o menos traumáticas possível, por isso sempre avisamos com antecedência quando um lançamento de uma versão maior estiver prevista para ocorrer.

⚠️

Fique atento(a)!

Não deixe para atualizar a sua versão no último momento! Evite aborrecimentos: programe-se!

Descontinuação

Ao chegar neste momento a versão foi efetivamente descontinuada e marcada como obsoleta. Na prática, isto significa que:

• ela não está mais disponível para utilização em nossos ambientes e todas as requisições realizadas simplesmente não serão respondidas;
• todos os atendimentos relacionados a ela serão encerrados pela equipe de suporte; e
• a documentação permanecerá disponível para fins históricos.

👍

Fique tranquilo(a)!

Nossa equipe sempre avisará quando uma nova versão estiver sendo descontinuada. Se preferir, você pode acessar nosso Repositório de Comunicados.

Tipos de versões

Utilizamos o Versionamento Semântico como base para o nosso controle de versão e consideramos os seguintes tipos de versões listados a seguir:

• Versão de Correção: acrescenta ao menos uma mudança interna que corrige um comportamento incorreto enquanto mantém a retrocompatibilidade em relação à última versão;
• Versão Menor: acrescenta uma nova funcionalidade (ou melhoria) compatível (non-breaking change) em relação à última versão. Pode incluir mudanças em nível de correção;
• Versão Maior: introduz mudanças incompatíveis (breaking changes) em relação à sua última versão correspondente e pode incluir alterações em nível de Versão Menor e de Versão de Correção.

📘

Importante

As credenciais de acesso associadas às APIs são agnósticas à versão.

Máquina de estados

Abaixo, compartilhamos os diferentes estados que nossas versões podem assumir durante o ciclo de desenvolvimento. Esperamos que, assim, fique mais claro sobre como lidar com cada um dos lançamentos que virão.

Rascunho

Estado inicial de planejamento da versão e definição dos seus objetivos e escopo de trabalho.

Instável

Estado em que a versão já está sendo desenvolvida. Pode ser dividida em 3 subestados:

• Alpha: a versão está em estado inicial de desenvolvimento. 100% dos testes são executados internamente;
• Beta: a versão está em estado intermediário de desenvolvimento e pode ser testada com um grupo limitado de usuários;
• Release candidate: a versão está quase pronta para o lançamento final, a não ser que problemas relevantes sejam identificados. Novas alterações são limitadas a correções de defeitos e questões de segurança.

⚠️

Fique atento(a)!

Reservamo-nos o direito de não utilizar os estados Beta e Release Candidate a depender da versão sendo desenvolvida, desde que não impacte na qualidade final da entrega.

Estável

A versão é considerada estável e adequada para disponibilização geral.

Deprecada

A versão ainda é suportada, mas será descontinuada em lançamentos futuros.

Obsoleta

A versão não é mais suportada e torna-se indisponível em ambiente produtivo.

📘

Procurando por algo específico?

Utilize nossos atalhos de teclado! Pressione Cmd + K (macOS) ou Ctrl + K (Windows) e digite o que você está precisando!