Outages

A tela de Outages permite gerenciar as indisponibilidades programadas para uma ou mais APIs, de forma que as manutenções sejam notificadas às APIs regulatórias do ecossistema.

Ao longo do seu ciclo de existência, as APIs do Open Finance passam por momentos de indisponibilidade, paradas programadas para realizar manutenções. Essas paradas são chamadas de Outages e devem ser comunicadas ao ecossistema de Open Finance.
Para saber mais, leia Relatórios e Métricas.

Create Outage

Permite cadastrar uma indisponibilidade através do botão Create no canto inferior direito da tela. Ao acioná-lo, preencha os campos:

Name

Para identificar o outage. Deve conter até 240 caracteres.

Explanation

Com a explicação sobre os motivos da indisponibilidade.

Start

Data e hora programada para o início da indisponibilidade.

End

Data e hora programada para o encerramento da indisponibilidade.

Unavailable Endpoints

Para identificar quais endpoints estarão indisponíveis. A lista mostra todas as famílias e APIs específicas disponíveis para a sua empresa, é necessário selecionar ao menos uma.

É possível agendar uma mesma indisponibilidade para todo o ecossistema ao marcar a caixa de seleção [All Endpoints], ou selecionar famílias e APIs específicas na listagem.

As indisponibilidades cadastradas são retornadas na API regulatória.

Details

Permite visualizar em detalhes um registro de outage. Ao clicar sobre o ícone de seta Detalhes, você pode conferir a explicação sobre os motivos da indisponibilidade, data e hora previstas para encerramento e os endpoints indisponíveis durante o processo, conforme demonstrado abaixo:

details


Além de visualizar a listagem de todos os outages cadastrados, o grid permite:

  • Editar um outage que ainda não foi executado Editar

  • Deletar um outage cadastrado Deletar

  • Filtrar por período. Ao clicar sobre o ícone de funil Funil, é possível ainda fazer um filtro combinado, acrescentando os campos Name e Endpoint à busca.

Para buscar as informações inseridas no filtro, clique em [SEARCH]. Para limpar a pesquisa, clique em [CLEAR].

filtro

Thanks for your feedback!
EDIT
How useful was this article to you?