Campanhas
  1. Transbordo de Notas
Campanhas
  • CRMALL - Hosts
  • Campanhas
    • Autorização
      • Autorização
    • Documentos
      • Fluxo Geral - Integração para Envio e Processamento de Documentos
      • Envio de documentos por imagem
      • Envio de documentos por código eletrônico
      • Lista de documentos
      • Detalhes de um documento
    • Listagem de Campanhas
      • Listagem de Campanhas
    • Parâmetros da Campanha
      • Parâmetros da Campanha
    • Prizor SDK Web
      • Gerar URL
    • Transbordo de Notas
      • Transbordo de Notas
      • Recuperar mensagens da fila SQS
        GET
  1. Transbordo de Notas

Transbordo de Notas

Arquitetura#

Após o envio de notas para o Campanhas e o devido processamento, as
transcrições serão entregues, via transbordo, em uma fila Amazon SQS e as
imagens em um bucket Amazon S3, conforme fluxo:
image.png

Recuperação das transcrições - AWS SQS/S3#

Atenção: Entre em contato caso não tenha recebido as informações abaixo.
● ACESS_KEY_ID: ID para acesso ao SQS e S3.
● SECRET: Secret pra acesso ao SQS e S3.
● URL SQS: URL do SQS onde as mensagens ficam armazenadas.
● BUCKET: Bucket S3 para armazenamento das imagens.
Exemplo:

Consumo de mensagens da fila - AWS SQS#

Documentação Oficial:
https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ReceiveMessage.html
Devem ser utilizados ACESS_KEY_ID, SECRET e URL SQS.
O conteúdo da transcrição fica no campo Body da mensagem recebida.
Exemplo:
Atenção: As mensagens ficarão disponíveis por 14 dias no SQS, a partir do
recebimento. Após este período serão excluídas, independente se foram lidas/recebidas
alguma vez.

Notas inválidas para a Campanha#

As notas podem ser invalidadas por vários motivos. Por exemplo, por regras de campanha, documentos inválidos, documentos ilegíveis etc.
Atentar para o campo invoice.infoDocument da mensagem recebida do SQS. A
transcrição será válida apenas se o valor for nulo.
image.png
A transcrição é inválida (invoice.infoDocument != null)
image.png
Observação
Os campos do payload da transcrição para notas inválidas para a campanha podem ou não vir com informações.
Notas eletrôncias geralmente contém o link do QRCode da nota. No entanto, se forem inválidas, podem não vir com o payload.

Excluir mensagens - AWS SQS#

Documentação Oficial:
https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessage.html
Após a mensagem ser lida, será necessário apagá-la. Para excluir uma mensagem deve
ser utilizado o parâmetro ReceiptHandle recebido com a mensagem. Esse valor será
informado para o método deleteMessage processar a exclusão.

Recuperar imagem - AWS S3#

Documentação Oficial:
https://docs.aws.amazon.com/AmazonS3/latest/userguide/download-objects.html
Caso o campo image esteja preenchido, é necessário buscar a imagem dentro do AWS
S3. Utilizar o campo path_s3 para recuperá-la.
Exemplo:
image.png
Modificado em 2025-03-31 13:12:44
Página anterior
Gerar URL
Próxima página
Recuperar mensagens da fila SQS
Built with