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

Contexto

APIs de Status, de Outages e Métricas são comuns e obrigatórias a todas as instituições 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 pela Estrutura de Governança do Open Finance para avaliação e controle da qualidade dos serviços fornecidos pelas instituições participantes.

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

Para garantir a segurança cibernética e evitar a potencial exposição de dados, as instituições que desejarem restringir o acesso à API Admin devem liberar o acesso apenas aos endereços de IP especificados na tabela abaixo:

Essa medida visa proteger contra possíveis ataques e também evitar o uso indevido de recursos e a transmissão de dados. As instituições que optarem por não implementar essas restrições de acesso devem estar cientes das implicações associadas.

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

Open

Dicionário de Dados

Fazer download do dicionário de dados