Tempo de Resposta das 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 tempo de resposta, estabelecidos no Manual de APIs do Open Finance.

Considerando que, o tempo de resposta de cada requisição é o tempo transcorrido entre o recebimento de uma requisição que não ultrapassa os limites de tráfego e o momento em que a requisição é completamente respondida.

Sobre a Métrica

A métrica de Tempo de Resposta das APIs considera o valor do percentil 95 e o número de requisições ocorridas no dia.

As medições devem ser realizadas de maneira independente para cada versão "major" dos endpoints em produção e devem ser consideradas as requisições com todos os códigos de retorno possíveis, com exceção dos associados a limites de tráfego e limites operacionais.

O valor do tempo de resposta 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 desempenho, 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".

Os endpoints das APIs deverão manter, diariamente, o SLA do percentil 95 do tempo de resposta em no máximo:

I - 1.500ms, em endpoints classificados como de alta e média-alta frequências;

II - 2.000ms, em endpoints classificados como de média frequência; e

III - 4.000ms, em endpoints classificados como de baixa frequência.

A conformidade é avaliada mensalmente, verificando se os endpoints das APIs das instituições participantes atenderam aos SLAs do desempenho.

Metodologia Simplificada

A metodologia adotada para o monitoramento do tempo de resposta das APIs avalia se, diariamente, o percentil 95 dos endpoints cumpre o seu SLA, ou seja, se em um dia que o endpoint avaliado receba 100 requisições, o tempo de resposta de pelo menos 95 requisições é inferior ao SLA.  

Aspectos Técnicos

O monitoramento inclui várias etapas:

• Filtro inicial dos dados provenientes da PCM:

• Agrupamento dos dados:

• Cálculo do percentil

  • coleta dos dados: Seja R o conjunto de todos os tempos de resposta de um dia, onde ri é o tempo de resposta da i-ésima requisição. Ou seja, R={r1, r2, ..., rn}; Nessa coleta é utilizado o processtimespan quando clientorgid=organisationid ou serverorgid=organisationid e status ‘UNPAIRED’

  • cálculo do índice do percentil 95: o índice para o percentil 95, denotado por i95, é calculado pela fórmula i95 = 0.95 ∗ n, arredondado para o número inteiro mais próximo, e onde n representa número de requisições;

  • ordenação dos dados: O conjunto R em ordem crescente para obter o conjunto ordenado Rord={r(1), r(2), ..., r(n)}, onde r(1) é o menor tempo de resposta e r(n) é o maior;

  • obtenção do valor do percentil 95: o valor do percentil 95, denotado por P95, é o valor no índice i95 no conjunto ordenado Rord. Ou seja, P95 = r(i95)

Interpretação dos Resultados

Para fins do processo de monitoramento, o período de apuração referente a este item é mensal e a análise de desconformidade é feita por conglomerado. A título de exceção, no caso de conglomerados que possuam equipes N2 por CNPJ, a desconformidade será gerada para a instituição.

Considera-se que um endpoint está em conformidade caso tenha respeitado o SLA do desempenho em pelo menos 90% dos dias do mês de referência, arredondando-se para o número inteiro mais próximo, desde que o valor do percentil 95 dos demais dias não tenha sido superior ao SLA do desempenho aumentado em 20%. Os dias do mês de referência são os dias do mês em que houve requisições para o endpoint avaliado.

Assim, consideramos cada conformidade diária:

P95<SLA – CONFORME

SLA<P95<SLA*1,2 – DENTRO DA TOLERÂNCIA

P95>SLA*1,2 – NÃO CONFORME

E fazemos a apuração mensal:

Se a quantidade de dias não conforme >0  –  NÃO CONFORME

Se a quantidade de dias conforme >=  90% de dias de acionamento – CONFORME

Se a quantidade de dias não conforme < 90% de dias de acionamento – NÃO CONFORME

A métrica não se aplica às APIs de "Webhook".

I - Em um mês de 30 dias, em que um endpoint de alta frequência tenha apresentado valor de P₉₅ inferior a 1.500ms em 27 dias e, nos demais dias, tenha apresentado valor de P₉₅ entre 1.500ms e 1.800ms (1.500ms * 1,2 = 1.800ms), o endpoint está em conformidade para fins do processo de monitoramento naquele mês.

II - Em um mês de 31 dias, em que um endpoint de alta frequência tenha apresentado valor de P₉₅ inferior a 1.500ms em 28 dias e, nos demais dias, tenha apresentado, em pelo menos um dos dias, valor de P₉₅ superior a 1.800ms (1.500ms * 1,2 = 1.800ms), o endpoint não está em conformidade para fins do processo de monitoramento naquele mês.

Dados e Fontes

Para o cálculo desta métrica, a fonte informacional é a Plataforma de Coleta de Métricas (PCM), que consolida os dados a partir dos reportes enviados pelas instituições participantes.  Todos os métodos e recursos dos endpoints serão avaliados. Esses dados são consolidados 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.

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