Pular para o conteúdo principal

📘 Guia para Reporte de Desconformidades no Open Finance Brasil

Leonardo

Prezada Instituição,

Para que possamos analisar e tratar de forma ágil e eficaz as desconformidades reportadas no contexto do Open Finance Brasil, é essencial que as informações fornecidas estejam completas e bem estruturadas. Este documento apresenta:

  1. Os principais tipos de desconformidades;

  2. Os dados necessários para cada tipo;

  3. Como extrair essas informações, principalmente via Amazon QuickSight;

  4. O formato esperado na abertura do chamado técnico.

⚠️ Tipos de Desconformidades e Procedimentos

⏱️ 1. Desconformidade por Tempo de Resposta das APIs

Descrição:
O tempo de resposta da API está superior ao permitido pelas regras do Open Finance, impactando a experiência dos consumidores ou integradores.

✅ Informações que devem ser fornecidas no chamado:

  • Nome da Instituição Receptora

  • Nome da Instituição Fornecedora

  • Endpoint da API envolvida

  • Ambiente (Produção ou Sandbox)

  • Data e hora do(s) evento(s)

  • Tempo de resposta observado

  • ID da requisição (se aplicável)

  • Código de status HTTP retornado

  • Logs da aplicação (se disponíveis)

📊 Como obter via QuickSight:

  1. Acesse o Painel de Monitoramento do Open Finance. (Cao não tenha acesso clique neste link de formulário de solicitaçào de acesso)

  2. Selecione o painel referente ao Monitoramento de APIs.

  3. Aplique os filtros:

    • Instituição Receptora

    • Instituição Fornecedora

    • Período de análise

  4. Exporte os dados relevantes:

    • Tempo médio de resposta por endpoint

    • Percentil (p95 ou p99) de tempo de resposta

    • Quantidade de chamadas por status code

📤 Formato esperado no chamado:
Anexar planilha (CSV ou XLSX) com os dados extraídos do QuickSight e preencher a descrição do chamado com um resumo claro do ocorrido.

❌ 2. Erro de Retorno das APIs / Status Code Indevido

Descrição:
A API retorna um status code inesperado ou inconsistente com o contrato OpenAPI (ex: 500, 403 indevido, 404 em recurso válido).

✅ Informações necessárias no chamado:

  • Endpoint acessado

  • Payload da requisição (com dados sensíveis anonimizados)

  • Status code retornado

  • Mensagem de erro (se aplicável)

  • Data e hora da requisição

  • Headers relevantes (ex: x-fapi-interaction-id)

📊 Obtenção via QuickSight:

  1. Acesse o painel de Monitoramento de Erros de API.

  2. Filtre por:

    • Endpoint

    • Status Code

    • Data/Hora

  3. Exporte os logs com detalhes dos erros (se disponíveis).

📤 Formato esperado no chamado:
Anexar planilha com registros das falhas e incluir descrição técnica da inconsistência observada.

📉 3. Queda ou Intermitência de Disponibilidade

Descrição:
Períodos em que a API esteve fora do ar ou apresentou intermitência, violando a disponibilidade mínima exigida.

✅ Informações necessárias no chamado:

  • Datas e horários de indisponibilidade

  • Endpoints afetados

  • Evidências da falha (ex: logs de testes automatizados)

  • Volume de falhas (número de chamadas com erro / total de chamadas)

📊 Obtenção via QuickSight:

  1. Acesse o painel de Disponibilidade de APIs.

  2. Identifique os períodos com instabilidade ou erro elevado.

  3. Exporte os dados por endpoint e status code (ex: aumento de erros 5xx).

🔒 4. Problemas com Consentimento ou Fluxo de Autenticação

Descrição:
Falhas no fluxo de consentimento ou autenticação, como rejeição indevida de tokens ou não reconhecimento de consentimentos válidos.

✅ Informações necessárias no chamado:

  • Descrição do fluxo afetado (ex: autenticação, renovação de token, revogação)

  • Mensagens de erro

  • Dados do consentimento (ID, escopos solicitados)

  • Data e hora da tentativa

  • Logs do processo (quando aplicável)

📊 Obtenção via QuickSight:

  1. Acesse o painel de Consentimentos e Autenticação.

  2. Filtre por:

    • ID do consentimento

    • Status (falha, sucesso)

  3. Exporte os dados com os registros das sessões/autenticações.

📝 Como abrir um chamado

Ao identificar uma desconformidade, abra um chamado na plataforma de atendimento técnico, preenchendo os seguintes campos:

  • Título do chamado:
    [OPEN FINANCE] Desconformidade - Tipo do Problema

  • Descrição do chamado:

    • Descrição clara do problema

    • Data e horário do ocorrido

    • Instituições envolvidas

    • Endpoint e ambiente

    • Evidências disponíveis (logs, mensagens de erro, prints)

  • Anexos obrigatórios:

    • Planilhas extraídas do QuickSight

    • Logs da aplicação (se disponíveis)

⚠️ Importante: Certifique-se de anonimizar quaisquer dados sensíveis antes de anexar arquivos ao chamado.

📧 Exemplo de Preenchimento do Chamado

Título:
[OPEN FINANCE] Desconformidade - Tempo de Resposta Excessivo

Descrição:

Identificamos uma desconformidade referente ao tempo de resposta da API GET /accounts da instituição XPTO S.A.

Instituição Receptora: Banco Alpha  

Instituição Fornecedora: XPTO S.A.  

Data/Hora: 24/09/2025 - 14h35  

Tempo de resposta observado: 12s  

Status HTTP: 200  

Endpoint: GET /accounts  

ID da Requisição: abc123-fapi-id  

Em anexo, encaminhamos planilha extraída do QuickSight contendo o detalhamento das chamadas com tempos de resposta acima do SLA definido.

Atenciosamente,  

[Nome e contato da instituição]

 

Comentários

0 comentário

Artigo fechado para comentários.