Mensagens

Mensagens podem ser interpretadas como um registro de processando do documento. Um registro de mensagem contém informações como, resultado de validação, erros, comentários, anexos extras e outros. Todo documento importado pelo DocsM3, ao irá conter pelo menos uma mensagem. Porém é muito comum que documentos contenham mais de uma mensagem dependendo do fluxo de processamento.

A integração de recebimento de mensagens pode ser realizada de 2 maneiras: Pooling ou Webhook.

Pooling

Fluxo de Integração

Atenção

O fluxo de integração pode variar de acordo com o nível de processos requeridos pelo Sistema Corporativo. A representação abaixo considera um cenário básico de integração ponta-a-ponta.

• Cliente solicita mensagens → API retorna mensagens disponíveis
• Cliente processa mensagens e envia OK → API atualiza status da mensagens

Controle de Mensagens

O processo de recepção de mensagens possui um controle de lido/não lido para garantir que o processo de integração não processe mensagens repetidas. De maneira simples, você deve entender que o processo de integração de mensagens funciona como uma caixa de e-mail. Ou seja, quando uma mensagem é interpretada pelo Cliente ele deve informar ao DocsM3 que aquela mensagem foi processada com sucesso e portanto, será marcada como lida para que da próxima vez que o Cliente requisitar novas mensagens, as que ja foram marcada como lida, não serão listadas na consulta.

Exemplo via cURL

curl -X 'GET' \
  '/api/v1/Messages?%24top=50&%24filter=Processed%20eq%20false&%24orderby=CreatedOn%C2%A0desc&raw' \
  -H 'accept: application/json;odata.metadata=minimal;odata.streaming=true'

Mais detalhes em GET /api/v1/Messages.

Parâmetros da Requisição

Observe que a API de mensagens utiliza o padrão ODATA. para filtrar os dados a serem consultados. No exemplo acima, o parâmetro $top indica que serão retornados os primeiros 50 registros. Já o parâmetro $filter irá garantir que somente as mensagens não processadas serão retornadas. E por fim, o parâmetro $orderby indica que os registros retornados seguem a ordem dos mais novos para os mais antigos.

Webhook

Atenção

Estamos trabalhando para que em breve esse processo esteja disponível.

Próximos passos?

• Receber mensagens de evento → ver mais