Informações Gerais - API Admin - v2.0.1

Contexto

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.​

Sendo assim:

1. Todas as instituições devem publicar essas APIs que monitoram a situação do ambiente;

2. API de métricas deve reportar os dados de performance de todas as APIs que a instituição oferece;

3. API de métricas deve ser atualizada conforme lançamento de novas APIs pela instituição ou atualização das APIs já existentes.

Métricas: (GET /admin/v2/metrics)

Visão geral

Os dados das APIs Administrativas são consumidos apenas pelo Diretório para avaliação e controle da qualidade dos serviços fornecidos pelas Instituições Financeiras.

• Para o entendimento a respeito do cálculo do upTime e DownTime sugere o link de Disponibilidade;

• Para preenchimento do objeto invocativos sugere o link de Referência.

Listas de IPs liberados para acesso a API Admin​

As instituições que desejarem restringir o acesso à API Admin, por questões de segurança cibernética, deverão liberar o acesso aos seguintes endereços de IPs conforme tabela abaixo:

As instituições que decidirem não restringir o acesso, conforme sugerido, ficam cientes que estão assumindo os riscos decorrentes a possíveis ataques.​

Visão de alto nível das estruturas de dados

Open

Dicionário de Dados

Fazer download do dicionário de dados