Disponibilidade de APIs

Controle de versão

Introdução e Objetivos

Esta métrica visa monitorar se os endpoints das APIs das instituições participantes estão cumprindo os SLAs de disponibilidade, estabelecidos no Manual de APIs do Open Finance.

Considerando que a disponibilidade dos endpoints das APIs do Open Finance será calculada empiricamente, baseada na monitoração de requisições válidas.

Sobre a Métrica

A métrica de Disponibilidade das APIs mede a capacidade de uma API estar acessível e funcionando corretamente para os desenvolvedores e usuários finais.

As medições devem ser feitas todos os dias, em todas as faixas de 1 minuto disponíveis, iniciando na primeira faixa (00:00:00-00:00:59) e terminando na última faixa (23:59:00-23:59:59), considerando o horário de Brasília.

As medições devem ser realizadas de maneira independente para cada versão "major" dos endpoints em produção.

O status code a ser considerado para uma requisição é o valor reportado pelo consumidor da API, ou seja, o valor reportado pela instituição iniciadora de pagamentos nas APIs de “Serviços de Iniciação de Pagamentos” e o valor reportado pela receptora de dados no caso de APIs de "Dados Cadastrais e Transacionais".  

Na falta de informações dos consumidores, serão utilizadas as informações dos provedores para o cálculo do SLA de disponibilidade, ou seja,  o valor reportado pela instituição detentora de contas nas APIs de "Serviços de Iniciação de Pagamentos", e o valor reportado pela instituição transmissora de dados no caso de APIs de "Dados Cadastrais e Transacionais".

A indisponibilidade programada não exime o cálculo da disponibilidade no período apurado.

A disponibilidade de endpoints que não tenham requisições válidas no período apurado será considerada "indefinida", não estando sujeita a um SLA.

Cada um dos endpoints das APIs categorizadas como "Dados Abertos", "Dados Cadastrais e Transacionais", "Relatórios e Métricas", por versão, e os endpoints das APIs de "Segurança" "/register" e "/token", deverão satisfazer os requisitos mínimos de disponibilidade abaixo:

I - disponibilidade diária (calendário): 95%; e

II - disponibilidade longa (média móvel de 90 dias), medida diariamente: 99,5%.

As APIs classificadas como "Serviços de Iniciação de Pagamentos" seguem o definido na regulamentação do Pix, ou seja, ou seja os participantes têm metas de índice de disponibilidade diferentes, de acordo com as suas categorias de participação no arranjo:

A conformidade é avaliada mensalmente, verificando se os endpoints das APIs das instituições participantes atenderam aos SLAs de disponibilidade. A aferição mensal deve considerar a disponibilidade longa do último dia do mês de referência.

Metodologia Simplificada

Para fins de monitoramento deste item, o período de apuração será mensal, conforme orientado pelo Manual de Monitoramento do Open Finance Brasil. A avaliação envolverá:

Para as APIs de “Dados Abertos", "Dados Cadastrais e Transacionais", "Relatórios e Métricas", por versão, e os endpoints das APIs de "Segurança" "/register" e "/token":

• Disponibilidade diária: monitoramento da disponibilidade em todos os dias do mês de referência.

• Disponibilidade longa: monitoramento da da disponibilidade longa como média móvel dos últimos 90 dias.

Para as APIs de “Serviços de Iniciação de Transação de Pagamentos” monitoramento mensal de acordo com a regulamentação do Pix, .

Aspectos Técnicos

O monitoramento inclui várias etapas:

• Agrupar por minuto e contar as requisições com sucesso e erro

Filtragem

• organisationid = r.clientorgid OU (organisationid = serverorgid E status = 'UNPAIRED')

• statuscode = 2xx, 5xx, 408 ou 422

• status ≠ “PAIRED_INCONSISTENT”

Agrupamento

• serverorgid

• endpoint

• dia

• minuto

Contar as requisições por tipo

total_validas → total de chamadas

success → total chamadas com statuscode  2xx ou 422

error → total chamadas com statuscode 5xx OU 408

• Calcular a disponibilidade do minuto

Para cada minuto, realiza o calculo do percentual de disponibilidade

 disponibilidade_no_minuto = (success / (sucess + errors)) * 100

• Agrupar por dia e calcular o total de minutos disponíveis

Agrupamento

• serverorgid

• endpoint

• dia

Cálculo

total_validas_dia → total de chamadas no dia

total_minutos_disponiveis → total disponibilidade_no_minuto ≥ 95%

total_minutos → total de minutos do dia

• Calcular disponibilidade e conformidade diária, mensal e longa

 Disponibilidade diária

percent_disp_dia = total_minutos_disponiveis / total_minutos

Conformidade diária

percent_disp_dia ≥ 0.95 ?

então “CONFORME” se não “NÃO CONFORME”

Disponibilidade mensal (Iniciação de pagamentos)

percent_disp_mensal = média mensal de percent_disp_dia

Conformidade mensal (Iniciação de pagamentos)

percent_disp_mensal ≥ Categoria de disponibilidade PIX da instituição ?

então “CONFORME” se não “NÃO CONFORME”

Disponibilidade longa

percent_disp_u90d = média dos últimos 90 dias de percent_disp_dia

Conformidade longa

percent_disp_u90d ≥ 0.995 ?

então “CONFORME” se não “NÃO CONFORME”

Interpretação dos Resultados

Os resultados da métrica serão interpretados para verificar se as instituições estão cumprindo os critérios de conformidade para disponibilidade das APIs. A análise incluirá:

Disponibilidade das APIs

Disponibilidade Diária

• A disponibilidade pontual (t) é calculada como a fração do total de requisições válidas processadas com sucesso a cada intervalo de 1 minuto. Por exemplo, a disponibilidade pontual de um endpoint referente ao minuto 11:34, de um determinado dia, no qual houve um total de requisições válidas com sucesso de 255 e um total de requisições válidas com erro de 4, é calculada da seguinte forma:

Open

A disponibilidade diária é calculada baseada nas informações das disponibilidades pontuais.

Disponibilidade Longa

• A disponibilidade longa é calculada diariamente como média móvel das disponibilidades dos últimos 90 dias corridos. Por exemplo, a disponibilidade longa do último dia de março é a média das disponibilidades diárias dos últimos 90 dias.

A conformidade para a disponibilidade das APIs depende da conformidade em todos os dias da disponibilidade diária das APIs e da sua disponibilidade longa, considerando o último dia do mês de apuração. As APIs de “Serviços de Iniciação de Pagamentos” seguem as metas do índice de disponibilidade do arranjo Pix.

Para ilustrar as condições de conformidade e desconformidade, considere os seguintes exemplos:

Conformidade

Por exemplo, considerando um dia em que houve requisições válidas em 1.390 das 1.440 faixas de 1 minuto possíveis (1 dia = 24h * 60min= 1.440 faixas de horário) para um endpoint específico "x" de versão 1, e dos quais 30 períodos tiveram a disponibilidade menor que o limite de disponibilidade definido (95%), a Disponibilidade Diária de "x" v1 será igual a:

Dados e Fontes

Para o cálculo da métrica, utiliza-se um conjunto diversificado de dados provenientes de diferentes fontes. A principal fonte informacional é a Plataforma de Coleta de Métricas (PCM), que consolida os dados a partir dos reportes enviados pelas instituições participantes. Além disso, as planilhas auto reportadas pelas instituições são integradas e consolidadas na Plataforma Analítica de Dados (PAD), um repositório centralizado que serve como base para a análise e avaliação da métrica. Essa combinação de dados provenientes da PCM e das planilhas auto reportadas permite uma avaliação precisa da métrica e um monitoramento efetivo do desempenho e disponibilidade das APIs no contexto do Open Finance.

Limitações e Considerações

Atualmente, não há visibilidade ou conhecimento de limitações ou considerações adicionais para esta métrica. A análise será continuamente revisada e aprimorada conforme novos dados e informações se tornem disponíveis.

Responsável pela Aprovação

GT Arquitetura