Pular para o conteúdo principal

Sumarização API

A API Sumarização permite o gerenciamento e a consulta de dados consolidados, incluindo métricas, faturamento e inconsistências.

Swagger

NSConnect

GET /sumarizacao​

Consulta dados sumarizados.

Parâmetros​

  • Terminal (query, obrigatório): Identificação do terminal.
  • Cnpj (query, opcional): CNPJ associado.
  • DataEvento (query, obrigatório): Data do evento.
  • Ramo (query, obrigatório): Categoria do evento.

Respostas​

  • 200 OK - Retorna os dados sumarizados.
  • 401 Unauthorized - Falha na autenticação.

POST /sumarizacao​

Envia novos dados para sumarização.

Corpo da Requisição (JSON)​

[
  {
    "terminal": "string",
    "cnpj": "string",
    "dataEvento": "2025-04-10T06:25:35.861Z",
    "ramo": "string",
    "tipoOperacao": "string"
  }
]

Respostas​

  • 200 OK - Dados registrados com sucesso.
  • 401 Unauthorized - Falha na autenticação.

GET /sumarizacao/DoubleCheck​

Retorna registros para verificação duplicada.

Respostas​

  • 200 OK - Retorna os dados para análise.
  • 401 Unauthorized - Falha na autenticação.

PATCH /sumarizacao/DoubleCheck​

Atualiza registros de verificação duplicada.

Corpo da Requisição (JSON)​

[
  {
    "id": 0,
    "isTotalSimetrias": 0,
    "qtdeAverbacaoSimetrias": 0
  }
]

Respostas​

  • 200 OK - Registro atualizado com sucesso.
  • 401 Unauthorized - Falha na autenticação.

POST /sumarizacao/notificar​

Notifica um novo evento de sumarização.

Respostas​

  • 200 OK - Notificação registrada com sucesso.
  • 401 Unauthorized - Falha na autenticação.

PATCH /sumarizacao/notificar​

Atualiza o status de uma notificação.

Corpo da Requisição (JSON)​

{
  "id": 0,
  "status": "Erro"
}

Respostas​

  • 200 OK - Status atualizado.
  • 401 Unauthorized - Falha na autenticação.

POST /sumarizacao/Metricas​

Registra métricas de processamento.

Corpo da Requisição (JSON)​

[
  {
    "dataHoraProcessamento": "2025-04-10T06:25:35.870Z",
    "qtdeDocProcessados": 0,
    "tempoProcessamento": "string"
  }
]

Respostas​

  • 200 OK - Métricas registradas.
  • 401 Unauthorized - Falha na autenticação.

POST /sumarizacao/Faturamento​

Registra dados de faturamento.

Respostas​

  • 200 OK - Dados registrados.
  • 401 Unauthorized - Falha na autenticação.

POST /sumarizacao/Insconsistencias​

Registra inconsistências detectadas.

Respostas​

  • 200 OK - Inconsistências registradas.
  • 401 Unauthorized - Falha na autenticação.