A política para atualização dos dados tem como propósito estabelecer as diretrizes necessárias para governança do ciclo de vida de uma API, sendo essencial para garantir a integridade dos dados, além de reduzir os riscos associados a conformidade e promover a eficiência operacional ao definir processos eficazes para gerenciar as atualizações desses dados.
Utilizaremos como base para definição das diretrizes de atualização dos dados de API, a política de versionamento do Open Finance Brasil, uma vez que as termogias e padrões utilizados, são de conhecimento do ecossistema.
Atualização do Ciclo de Vida
Segundo a política de versionamento do Open Finance Brasil, o ciclo de vida de uma API possui 05 etapas após Design, considerada como etapa de concepção da API, logo, não incluímos como parte do processo. Portanto, a regra para atualização do ciclo de vida, deverá ocorrer quando:
Houverem mudanças de versão na API
Com isso, é necessário que sejam modificados os seguintes dados da API:
Status, considerando as etapas de Implementing, Certifying, Current, Deprecated ou Retired;
Data de Início, representado pelo formato
yyyy-MM-dd
, como por exemplo,2021-01-30
;Data Fim, representado pelo formato
yyyy-MM-dd
, como por exemplo,2021-01-30
.
Regras Gerais
A alteração dos dados de uma API para cada mudança de versão, devem ser consideradas como regras gerais:
A API deverá conter uma ÚNICA versão
Current
. Exceto, para um novo produto, tendo em vista que não existem versões anteriores;Se o versionamento de uma API for do tipo Patch, as datas de início e fim para os status de
Certifying
ouDeprecated
podem ser nulas (NULL), tendo em vista que não há um período de convivência.
Além disso, o preenchimento das datas de inicio e fim devem seguir as especificações abaixo, de acordo com as mudanças de status:
Status | Data de início | Data final |
Toda versão | Data da divulgação da primeira versão da especificação (beta.0) | Dia do primeiro marco |
Toda versão | Data da divulgação da especificação (beta.0) | Data do go-live |
Toda versão | Dia do primeiro marco | Fim do período do processamento de pedidos de certificação |
Toda versão | Data do go-live | - |
Toda versão | Data do go-live | Último dia do período de convivência |
Toda versão | Último dia do período convivência | Último dia do período convivência |
Toda versão | Dia do go-live da nova versão | Dia do go-live da nova versão |