Contexto:
Conforme IN nº 306 de 19/02/2022, o Item 2 do Anexo lista todas as APIs integrantes do Open Finance. Dentre elas, as APIs de Status, de Outages e Métricas são comuns a todos os participantes do Open Finance Brasil, independentemente da fase de adesão.
...
Todas as instituições devem publicar essas APIs que monitoram a situação do ambiente;
APIs comuns devem reportar os dados de disponibilidade e indisponibilidade programada de todas as APIs que a instituição oferece;
APIs comuns devem ser atualizadas conforme lançamento de novas APIs pela instituição ou atualização das APIs já existentes.
API de status: (GET /discovery/v1/status)
Visão geral
A instituição deve disponibilizar o código de status de todas as suas APIs nesse endpoint
Visão de alto nível das estruturas de dados
...
Dicionário de dados
Fazer download do dicionário de dados
API de outages: (GET /discovery/v1/outages)
Visão geral
A instituição deve disponibilizar previamente a previsão de indisponibilidade agendada dos seus serviços através desse endpoint.
Visão de alto nível das estruturas de dados
...
Dicionário de dados
Fazer download do dicionário de dados
Exemplo de código
Na estrutura de retorno exemplificada abaixo, no caso em que o parâmetro isPartial devolvido seja true, o array unavailableEndpoints deve conter a lista de endpoints indisponíveis:
...