Multiversionamento de APIs

Multiversionamento de APIs

Nesta página a participante irá encontrar informações sobre o que é o multiversionamento, materiais apresentados, gravações de Workshops referente ao tema.

1. Contexto

O multiversionamento é uma proposta estabelecida entre os ecossistemas Open Insurance (OPIN) e Open Finance (OFB) com objetivo de flexibilizar as correções das APIs do OPIN que são consumidas pelo ecossistema OFB. Atualmente as APIs do OPIN utilizadas pelo OFB, são referentes a Fase 1 (Dados Abertos):

  • Pessoas (Person)

  • Previdência - Cobertura de Risco (Pension Plan)

  • Capitalização (Capitalization Title)

Conforme as evoluções do ecossistema OPIN, surgiu a necessidade de que o multiversionamento também fosse aplicado as demais APIs e Fases OPIN, com a finalidade de promover a transição suave de versões major em produção, durante a execução de releases de melhorias ou em casos de ajustes emergenciais.

Assim em 2026 o ecossistema OPIN, passou a utilizar um novo processo de multiversionamento, buscando sustentar as necessidades do ambiente.

2. Governança de convivência entre APIs (OPIN e OFB)

Foi estabelecido em conjunto com OFB um período de conivência de versões entre as APIs de 180 dias a partir da data de fim da certificação. O período de convivência (definido pelo Manual de APIs da SUSEP) de 180 dias deve ser aplicado somente para as APIs do OPIN consumidas pelo OFB, conforme destacado no item “ 1. Contexto”.

Os Secretariados de cada ecossistema serão responsáveis em comunicar mensalmente a data fim de vigência da versão “desatualizada”.

Dessa maneira, quando houver o versionamento major das referidas APIs de Fase 1 (Person, Capitalization Title, Pension Plan), o processo de convivência se dará conforme a ilustração a seguir:

3. Governança de convivência entre APIs (OPIN)

Visto que o OFB consome somente as 3 APIs de Fase 1 (Person, Capitalization Title, Pension Plan) do ecossistema OPIN, somente essas precisam de convivência de 180 dias (6 meses), para que o OFB possa se adequar as alterações realizadas pelo OPIN.

No que se refere as APIs consumidas somente pelo ambiente OPIN (todas as APIs de Fases 2, 3 e as demais da Fase 1), o período de convivência aplicado para a transição de versões major em produção, poderá ser de:

  • 45 dias corridos;

  • 60 dias corridos;

  • 90 dias corridos.

desde que o backlog priorizado esteja atrelado a uma release de melhorias. O que definirá o período de convivência em uma release de melhorias(45, 60 ou 90 dias), será a análise do Grupo Técnico de Escopo de Dados da Estrutura de Governança, que considerará a complexidade desse backlog (Qtd. de alterações priorizadas, Qtd de APIs envolvidas e dificuldade de implementação das alterações)

Quando for necessário a aplicação de uma alteração emergencial major (hotfix major), o cronograma de adequação que envolve

  • Ajustes das ferramentas de conformidade;

  • Certificação das participantes;

  • Convivência de versões em produção.

será definido pelo GT de Dados conforme o cenário do hotfix em questão, ou seja, poderá variar conforme as APIs e alterações envolvidas, complexidade de implementação e impacto para as participantes.

image-20260203-184314.png

4. Acesso ao material do 3° Workshop de Multiversionamento

Evento realizado em 22/01/2026, apresentado pela Peers Consulting + Tecnology e tinha como objetivo apresentar os seguintes tópicos:

  • Histórico do multiversionamento no OPIN

  • Politica de versionamento e as premissas que embasam o novo modelo

  • Novo multiversionamento

  • Exemplificação de fluxo e parte prática

  • Dúvidas das participantes

material de apoio:

5. Mais informações sobre multiversionamento de APIs:

Para mais detalhes sobre os processos de versionamento de APIs ou sobre o fluxo de multiversionamento atualizado, recomendamos a consulta e leitura da Politica de Versionamento do OPIN. O documento traz definições como:

  • Quantidade de versões permitidas em produção

  • Quando inicia o período de convivência

  • Quando finaliza o período de convivência

  • Quais alterações são consideradas major, e quais não são.

  • Qual o fluxo de desenvolvimento de especificações e as particularidades de cada etapa

  • Detalhamento dos fluxos de avaliação e priorização de alterações.

  • E muito mais!

Para visualizar o referido documento, acesse no menu lateral esquerdo:

Manuais para participantes > Documentos > Manual de APIs > Download