Pular para o conteúdo principal

NSConnect

O NSConnect é um serviço que permite a comunicação eficiente entre sistemas por meio de uma fila de mensagens. Ele possibilita o envio e recebimento de dados estruturados, garantindo confiabilidade e rastreamento das informações.

Swagger

NSConnect

GET /message-queue

Este endpoint retorna uma lista de mensagens na fila de processamento.

Parâmetros

  • Nenhum parâmetro é necessário para essa requisição.

Resposta - 200 OK

Retorna um array de objetos representando as mensagens na fila:

[
{
"receiptHandle": "string",
"mensagemId": "string",
"sequenceNumber": 0,
"lockToken": "string",
"identificacao": 0,
"cpfcnpj": "string",
"filial": "string",
"serie": "string",
"numero": "string",
"dataEmissao": "2025-04-10T05:23:56.585Z",
"tipoDocto": "string",
"tipoTransp": "string",
"valorMercadoria": 0,
"placa": "string",
"cpfMotorista": "string",
"rastreado": true
}
]

Possíveis Erros

  • 400 Bad Request: Requisição inválida.
  • 401 Unauthorized: Falha na autenticação.

DELETE /message-queue

Este endpoint remove uma mensagem específica da fila.

Parâmetros

Os seguintes cabeçalhos são obrigatórios:

  • receiptHandle: Identificador único da mensagem.
  • messageId: ID da mensagem.
  • sequenceNumber: Número de sequência da mensagem.
  • lockToken: Token de bloqueio da mensagem.

Resposta - 200 OK

Se a exclusão for bem-sucedida, retorna:

true

Possíveis Erros

  • 400 Bad Request: Requisição inválida.
  • 401 Unauthorized: Falha na autenticação.