Leonardo.araujo (discussão | contribs)
Santos.paula (discussão | contribs)
Linha 12: Linha 12:
== Requisitos Funcionais ==
== Requisitos Funcionais ==
<br>
<br>
• [RF001] Autenticar: O sistema deve autenticar o usuário corretamente.
• [RF001] Consultar data do último SIM Swap: A API permite que o consumidor consulte a data e hora do último evento de SIM Swap associado a uma linha móvel.  
<br>
<br>


• [RF002] Escolha de débito: O sistema permite ao usuário escolher qual método
• [RF002] Verificar se houve SIM Swap em um período passado: A API permite verificar se ocorreu SIM Swap dentro de um intervalo definido.
de débito a ser aplicado.
<br>
<br>


• [RF003] Proteção anti-fraudes: Identificação correta do usuário para evitar
• [RF003] Validar período máximo de verificação: O campo maxAge aceita valores entre 1 e 2400 horas e possui valor padrão de 240 horas quando não informado.
fraudes.
<br>
<br>


• [RF004] Serviços de localização: Determinar se o dispositivo móvel está em
• [RF004] Identificar número da linha via token ou payload: A API identifica o número da linha através do campo phoneNumber obrigatório no corpo da requisição.  
área específica.
<br>
<br>


• [RF005] Garantir a comunicação: Garantir canal correto entre dispositivo móvel
• [RF005] Retornar erros padronizados CAMARA: O sistema mapeia erros para Status Codes HTTP padrão e retorna uma estrutura JSON de erro contendo status, code e message.
e ISP.
<br>
 
• [RF006] Consulta de dados do assinante: Webservice aceita consultas formato
E.164 (MSISDN).
<br>
 
• [RF007] Retornar histórico de SIM Swap: Retornar data da última alteração
ou booleano (swapped: true/false) nas últimas 24h.
<br>
 
• [RF008] Tratamento de exceções: Mapear erros HTTP (400, 404, 500) e retor-
nar JSON com code e message.
<br>
<br>



Edição das 11h53min de 7 de janeiro de 2026

Link do caso de uso: Open Gateway


Escopo



Requisitos


Requisitos Funcionais


• [RF001] Consultar data do último SIM Swap: A API permite que o consumidor consulte a data e hora do último evento de SIM Swap associado a uma linha móvel.

• [RF002] Verificar se houve SIM Swap em um período passado: A API permite verificar se ocorreu SIM Swap dentro de um intervalo definido.

• [RF003] Validar período máximo de verificação: O campo maxAge aceita valores entre 1 e 2400 horas e possui valor padrão de 240 horas quando não informado.

• [RF004] Identificar número da linha via token ou payload: A API identifica o número da linha através do campo phoneNumber obrigatório no corpo da requisição.

• [RF005] Retornar erros padronizados CAMARA: O sistema mapeia erros para Status Codes HTTP padrão e retorna uma estrutura JSON de erro contendo status, code e message.

Requisitos Não Funcionais


• [RNF001] Garantir qualidade de comunicação: Latência média API-Database < 200ms em 95% das requisições.

• [RNF002] Rapidez na resposta: Autenticação em menos de 1 segundo.

• [RNF003] Segurança: OAuth 2.0 (Client Credentials), JWT e HTTPS (TLS 1.2+).

• [RNF004] Disponibilidade: 99% do tempo, 24 horas por dia.

• [RNF005] Padronização: Seguir requisitos do Camara Project.

• [RNF006] Logs: Registrar logs JSON (timestamp, endpoint, status). Mascarar PII.

Regras de Negócio


• [RN001] Dados obrigatórios: A consulta deve conter um número de telefone válido.

• [RN002] Persistência de logs: Nenhuma requisição sem registro de auditoria.

• [RN003] Retenção: Logs de SIM Swap armazenados por no mínimo 6 meses. O dado de troca reside no Database SPS (API Stateless)."

Cronograma


RF Descrição Início Tempo em dias Data Real entrega Maker %
01 0%
02 0%

Diagramas


Projeto


Plano de Testes


Ambiente


Histórico


  • 22/12/2025:
    • Mensagens entre Sensedia, Algar e Brain para retomada da configuração dos conectores
    • Preencher RFs e cronograma neste link.


Equipe


  • Paula Nunes
  • Lucas Lacerda
  • Marcus Brunelli