{"info":{"_postman_id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","name":"Modus Services","description":"

Conjunto de APIs que dão acesso à serviços dos sistemas Modus. Os endpoint's podem ser executados diretamente via Modus Scheduler (agendador de tarefas).

As chamadas a estes serviços podem ser realizadas a partir de qualquer client REST, desde que possua um token gerado a partir dos sistemas Modus.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7351139","collectionId":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","publishedId":"2s8YmLvira","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2024-07-16T21:01:24.000Z"},"item":[{"name":"email","item":[{"name":"send","id":"c94b026a-6c0c-486b-9bfd-f84a878654f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"to\": \"suporte@viaregra.com;teste@viaregra.com\",\r\n \"cc\": \"cc@viaregra.com\",\r\n \"cco\": \"cco@viaregra.com\",\r\n \"subject\": \"Teste - Envio de e-mail\",\r\n \"body\": \"Corpo da mensagem\",\r\n \"ReadConfirmation\": \"True\",\r\n \"attachments\": [\r\n \"C:\\\\Temp\\\\OS-455.pdf\",\r\n \"C:\\\\Temp\\\\OS-456.pdf\" \r\n ]\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:9090/modus/email/send","description":"

Endpoint para envio de e-mail através da API dos sistemas Modus.

Ao realizar a chamada, o e-mail será enviado de forma síncrona. Pode ser adicionado texto usando tags HTML no corpo da mensagem.

Ao utilizar a chave attachments na chamada, certifique-se de que o caminho e o arquivo estejam disponíveis no servidor onde o Modus Server está instalado.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","name":"Modus Services","type":"collection"}},"urlObject":{"port":"9090","path":["modus","email","send"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"6a0c13a9-b5c8-4e6c-92b5-a4c48f0aeccb","name":"send","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"to\": \"suporte@viaregra.com;teste@viaregra.com\",\r\n \"cc\": \"cc@viaregra.com\",\r\n \"cco\": \"cco@viaregra.com\",\r\n \"subject\": \"Teste - Envio de e-mail\",\r\n \"body\": \"Corpo da mensagem\",\r\n \"ReadConfirmation\": \"True\",\r\n \"attachments\": [\r\n \"C:\\\\Temp\\\\OS-455.pdf\",\r\n \"C:\\\\Temp\\\\OS-456.pdf\" \r\n ]\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:9090/modus/email/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-type","value":"application/json"},{"key":"Content-length","value":"95"},{"key":"Date","value":"Thu, 20 Oct 2022 16:31:57 -0300"},{"key":"Server","value":"ModusServer processor"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"OK\",\n \"ResultCode\": 200,\n \"AsynchronousInfo\": {\n \"asynchronous\": false,\n \"asynchronous_id\": \"\"\n }\n}"}],"_postman_id":"c94b026a-6c0c-486b-9bfd-f84a878654f3"},{"name":"report","id":"3302200e-b9eb-4aef-b27c-2568b8735220","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \"email\": {\r\n \"to\": \"suporte@viaregra.com;teste@viaregra.com\",\r\n \"cc\": \"cc@viaregra.com\",\r\n \"cco\": \"cco@viaregra.com\",\r\n \"subject\": \"Teste - Envio de e-mail\",\r\n \"body\": \"Relatorios de pedidos da semana passada\",\r\n \"ReadConfirmation\": \"True\",\r\n \"attachments\": [\r\n \"C:\\\\Temp\\\\OS-456.pdf\" \r\n ]\r\n },\r\n \"reports\": [\r\n { \"report_id\": \"VEN001\",\r\n \"filename\": \"Resumo\",\r\n \"params\": {\r\n \"codemp\": \"1\",\r\n \"codfil\": \"1,2\",\r\n \"BaseDate\": \"$F(StartOfWeek)-1\",\r\n \"datemi\": \"$F(StartOfWeek),$F(EndOfWeek)\"\r\n }\r\n },\r\n { \"report_id\": \"VEN015\",\r\n \"filename\": \"Pedidos\",\r\n \"params\": {\r\n \"codemp\": \"1\",\r\n \"codfil\": \"1\",\r\n \"BaseDate\": \"$F(StartOfWeek)-1\",\r\n \"datemi\": \"$F(StartOfWeek),$F(EndOfWeek)\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:9090/modus/email/report","description":"

Permite a geração e posterior envio de relatórios através da API dos sistemas Modus.

Veja detalhes no endpoint /modus/report/email.

Endpoint para envio de e-mail via API dos sistemas Modus.

A configuração para envio de e-mail (servidor SMTP, login, etc) deve ser realizada diretamente no sistema.

\n","_postman_id":"da9968f9-0ad0-4a55-b78e-b962874d3e8d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","name":"Modus Services","type":"collection"}}},{"name":"report","item":[{"name":"pdf","id":"8a810e7b-9fe1-48cf-9f63-0333cf30001f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \"report_id\": \"VEN001\",\r\n \"params\": {\r\n \"codemp\": \"1\",\r\n \"codfil\": \"1,2\",\r\n \"BaseDate\": \"$F(StartOfWeek)-1\",\r\n \"datemi\": \"$F(StartOfWeek),$F(EndOfWeek)\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:9090/modus/report/pdf","description":"

Ao ser acionado, este end-point gera e retorna um PDF em modo síncrono.
Se for chamado diretamente pelo navegador, retornará um PDF diretamente no browser.

Envia um, ou mais, relatórios por e-mail como anexo em PDF.

A chave \"reports\" contém a lista de relatórios a serem enviados. Cada elemento deve conter obrigatoriamente 3 chaves:

\"report_id\": ID do relatório a ser emitido
\n
\"filename\": Nome do arquivo que será criado. Não precisa incluir a extensão PDF
\n
\"params\": Parâmetros para emissão do relatório.
\n

A passagem de parâmetros possui um marcador especial para parâmetros avulsos, utilizados para customizar o relatório. Estes parâmetros são iniciados por \"rptpar\" e devem ser programados no relatório. Veja nos exemplos de chamada \"parâmetros avulsos (rptpar)\".

A chave \"email\" contem os dados para envio do e-mail.

Veja detalhes no exemplo abaixo.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","name":"Modus Services","type":"collection"}},"urlObject":{"port":"9090","path":["modus","report","email"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"82085a88-6f9b-4d69-ac1a-aa7595f2c9c6","name":"email","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \"reports\": [\r\n { \"report_id\": \"VEN001\",\r\n \"params\": {\r\n \"codemp\": \"1\",\r\n \"codfil\": \"1,2\",\r\n \"BaseDate\": \"$F(StartOfWeek)-1\",\r\n \"datemi\": \"$F(StartOfWeek),$F(EndOfWeek)\"\r\n }\r\n },\r\n { \"report_id\": \"VEN015\",\r\n \"params\": {\r\n \"codemp\": \"1\",\r\n \"codfil\": \"1\",\r\n \"BaseDate\": \"$F(StartOfWeek)-1\",\r\n \"datemi\": \"$F(StartOfWeek),$F(EndOfWeek)\"\r\n }\r\n },\r\n ],\r\n \"email\": {\r\n \"to\": \"suporte@viaregra.com;teste@viaregra.com\",\r\n \"cc\": \"cc@viaregra.com\",\r\n \"cco\": \"cco@viaregra.com\",\r\n \"subject\": \"Teste - Envio de e-mail\",\r\n \"body\": \"Relatorios de pedidos da semana passada\",\r\n \"ReadConfirmation\": \"True\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:9090/modus/report/email"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-type","value":"application/json"},{"key":"Content-length","value":"95"},{"key":"Date","value":"Fri, 21 Oct 2022 17:04:52 -0300"},{"key":"Server","value":"ModusServer processor"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"OK\",\n \"ResultCode\": 200,\n \"AsynchronousInfo\": {\n \"asynchronous\": false,\n \"asynchronous_id\": \"\"\n }\n}"},{"id":"7663eb78-cc92-4c5b-890a-ec4493ba68ab","name":"parâmetros avulsos (rptpar)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \"reports\": [\r\n { \"report_id\": \"PES201\",\r\n \"filename\": \"aniversariantes\",\r\n \"params\": {\r\n \"codemp\": \"1\",\r\n \"rptparDia\": \"$F(Day)\",\r\n \"rptparMes\": \"$F(Month)\",\r\n \"rptparCodMdl\": \"2\",\r\n \"rptparGravar\": \"S\"\r\n }\r\n }\r\n ],\r\n \"email\": {\r\n \"to\": \"viaregra@viaregra.com\",\r\n \"subject\": \"Teste - aniversariantes\",\r\n \"body\": \"Teste de passagem de parametros customizados\",\r\n \"ReadConfirmation\": \"False\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:39001/modus/report/email"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-type","value":"application/json"},{"key":"Content-length","value":"95"},{"key":"Date","value":"Mon, 17 Mar 2025 10:00:57 -0300"},{"key":"Server","value":"ModusServer processor"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"OK\",\n \"ResultCode\": 200,\n \"AsynchronousInfo\": {\n \"asynchronous\": false,\n \"asynchronous_id\": \"\"\n }\n}"}],"_postman_id":"6ed945df-2f83-4497-a7c8-58fbb2c8fc78"}],"id":"ca64ae63-f9a5-4506-8115-6ba964fd3f6a","description":"

Endpoints para gerar (obter) e enviar relatórios via e-mail, através da API dos sistemas Modus. Ao realizar a chamada, o relatório será enviado de forma síncrona.
O tipo de retorno será dependente do endpoint chamado.

Chaves

report_id:

Identificador do relatório. Deve ser obtido consultando o Gerenciador de Relatórios dos sistemas Modus.

params:

Parâmetros a serem enviados/preenchidos automaticamente na entrada do relatório. Normalmente é utilizado o mesmo nome do campo da tabela principal do relatório. Consulte a entrada do relatório nos sistemas Modus para saber quais parâmetros podem ser passados. Em caso de dúvidas, solicite auxílio do suporte.

Na chave params podem ser enviadas algumas tags especiais para auxiliar na emissão de relatórios com datas dinâmicas. A documentação completa das macros e tags pode ser vista em Macros para tratamento de datas.

\n","_postman_id":"ca64ae63-f9a5-4506-8115-6ba964fd3f6a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","name":"Modus Services","type":"collection"}}},{"name":"message","item":[{"name":"integration","item":[{"name":"status","id":"dbbdbd08-fb44-4c3d-b44f-07566cbf8abb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"company\": 1,\n \"integrations\": [ ],\n \"email\": {\n \"error\": {\n \"to\": \"viaregra@viaregra.com\",\n \"subject\": \"Aviso - Instancias <>\",\n \"ReadConfirmation\": \"False\"\n },\n \"ok\": {\n \"to\": \"viaregra@viaregra.com\",\n \"subject\": \"Aviso - Instancias <>\",\n \"ReadConfirmation\": \"False\"\n },\n \"all\": {\n \"to\": \"viaregra@viaregra.com\",\n \"subject\": \"Aviso - Instancias <>\",\n \"ReadConfirmation\": \"False\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"localhost:9090/modus/message/integration/status","description":"

Verificar o status das integrações de mensagens (WhatsApp, etc). Ao detectar uma instância com status desconectada, envia um e-mail de aviso

Parâmetros:

company: Indica a empresa para processamento. Obrigatório.
\n
integrations: Array com códigos das integrações a serem verificadas. Opcional. Default Todas.
\n
email: Chave com os dados do e-mail do destinatário que será avisado sobre o status, divido em 3 grupos/objetos:
\n
- \"OK\": E-mails para envio de aviso das conexões OK/ativas
  \n
- \"ERROR\": E-mails para envio de aviso das conexões com erro/desconectadas
  \n
- \"ALL\": E-mails para envio de aviso das conexões OK/ativas e das conexões com erro.
  \n
\n

E-mails ativos e e-mails com erros serão enviados separadamente, para dar mais destaque.

Em \"subject\" da mensagem, pode-se utilizar a tag <> para substituir o status, sendo \"conectadas\" para instâncias conectadas e \"DESCONECTADAS\" para instâncias desconectadas.

Retornará o resultado do processamento dos eventos processados com sucesso e erro.

AGENDAMENTO

Recomenda-se agendar execuções em intervalo diário.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","name":"Modus Services","type":"collection"}},"urlObject":{"port":"9090","path":["modus","message","integration","status"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"d89c67c0-468e-4879-b289-c92d53a49ee7","name":"status","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"company\": 1,\n \"integrations\": [ ],\n \"email\": {\n \"error\": {\n \"to\": \"viaregra@viaregra.com\",\n \"subject\": \"Aviso - Instancias <>\",\n \"ReadConfirmation\": \"False\"\n },\n \"ok\": {\n \"to\": \"viaregra@viaregra.com\",\n \"subject\": \"Aviso - Instancias <>\",\n \"ReadConfirmation\": \"False\"\n },\n \"all\": {\n \"to\": \"viaregra@viaregra.com\",\n \"subject\": \"Aviso - Instancias <>\",\n \"ReadConfirmation\": \"False\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"localhost:39001/modus/message/integration/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-type","value":"application/json"},{"key":"Content-length","value":"414"},{"key":"Date","value":"Tue, 10 Jun 2025 18:25:35 -0300"},{"key":"Server","value":"ModusServer processor"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"OK\",\n \"ResultCode\": 200,\n \"integrations\": [\n {\n \"result\": \"ERRO\",\n \"integration\": 11,\n \"description\": \"PlugMessage WhatsApp\",\n \"queue\": 0,\n \"message\": \"Plugmessage desconectado Sessão desconectada Smartphone desconectado You are not connected.\"\n },\n {\n \"result\": \"OK\",\n \"integration\": 14,\n \"description\": \"BotSend WhatsApp\",\n \"queue\": 0,\n \"message\": \"Sessão conectada\"\n }\n ],\n \"AsynchronousInfo\": {\n \"asynchronous\": false,\n \"asynchronous_id\": \"\"\n }\n}"}],"_postman_id":"dbbdbd08-fb44-4c3d-b44f-07566cbf8abb"}],"id":"d030b7ff-42dd-4049-abca-b7ad1557f734","_postman_id":"d030b7ff-42dd-4049-abca-b7ad1557f734","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","name":"Modus Services","type":"collection"}}},{"name":"send","id":"8157b2a3-6404-4e7a-b4cf-2f64da3d7f7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"company\": 1,\n \"limit\": 0,\n \"types\": [ \n \"E\",\n \"W\",\n \"S\"\n ],\n \"modules\":[\n \"FC\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"localhost:9090/modus/message/send","description":"

Processar e enviar as mensagens presentes nas tabelas do sistema.

Parâmetros:

company: Indica a empresa para processamento. Obrigatório.
\n
types: Array com tipos de mensagens que serão processadas. Opcional.
\n
- E = E-mail
  \n
- W = WhatsApp
  \n
- S = SMS (não implementado)
  \n
\n
modules: Array com módulo de origem das mensagens que serão processadas. Opcional.
\n
- FC = Financeiro/Cobrança
  \n
- MN = Manual
  \n
- (ver domínio ORIMSG)
  \n
\n
limit: Limite máximo a ser processado na chamada. Válido para todos os tipos presentes em types.
Opcional. Zero envia todas as mensagens pendentes.
\n

Retornará o resultado e a quantidade de mensagens processadas com sucesso e erro.

O log de erros estará salvo na tabela do sistema, e pode ser obtido usando o end-point (não implementado).

AGENDAMENTO

Recomenda-se agendar execuções em intervalo de 5min ou 10min.

Salvar uma mensagem na tabela do sistema, para ser processada posteriormente pelo end-point /send.

Basicamente, os campos são os presentes nas tabelas TMsgPri, TMsgAne.

Parâmetros:

company: Indica a empresa para processamento. Obrigatório.
\n
type: Tipo de mensagem. Obrigatório.
\n
- E = E-mail
  \n
- W = WhatsApp
  \n
- S = SMS (não implementado)
  \n
\n
module: Módulo de origem da mensagem. Opcional, default MN.
\n
- FC = Financeiro/Cobrança
  \n
- MN = Manual
  \n
- (ver domínio ORIMSG)
  \n
\n

Demais campos seuem o padrão de e-mail (/modus/email/send).

A mensagem será salva com o status \"A\". Acompanhamento da execução deve ser feito pelo log do agendador e pelo log de mensagens.

Processar os eventos recebidos pelos Whe Hooks de mensagens.

Parâmetros:

company: Indica a empresa para processamento. Obrigatório.
\n
integrations: Array com códigos das integrações a serem processadas. Opcional. Default Todas.
\n

Retornará o resultado do processamento dos eventos processados com sucesso e erro.

AGENDAMENTO

Recomenda-se agendar execuções em intervalo de 5min ou 10min.

End points para tratamento de envio de mensagens do sistema.

Utilizará o processador de mensagens em background do sistema para o envio de mensagens automatizadas e em segundo plano.

Web hooks serão programados nesta pasta, conforme o serviço

\n","_postman_id":"a5899c8c-f848-4aaa-ad7d-aabdc42fefe2","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","id":"a7b0247f-41a8-4f64-a6a8-f9533bdec953","name":"Modus Services","type":"collection"}}},{"name":"message/auto","item":[{"name":"send","id":"82135cad-b71f-418e-8a54-3966ea92c069","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"company\": 1\n}","options":{"raw":{"language":"json"}}},"url":"localhost:9090/modus/message/auto/send","description":"

Processa as mensagens presentes na tabela de mensagem automática (TMsgAut) que estão em situação \"A\"

Parâmetros:

company: Indica a empresa para processamento. Obrigatório.
\n
types: (NÃO IMPLEMENTADO)
Array com tipos de mensagens que serão processadas. Opcional.
\n
- E = E-mail
  \n
- W = WhatsApp
  \n
- S = SMS (não implementado)
  \n
\n

Retornará o resultado e a quantidade de mensagens processadas com sucesso e erro.

O log de erros estará salvo na tabela do sistema, e pode ser obtido usando o end-point (não implementado).

AGENDAMENTO

Recomenda-se agendar execuções em intervalo de 5min ou 10min.

Salvar uma mensagem na tabela do sistema, para ser processada posteriormente pelo end-point /send.

Basicamente, os campos são os presentes nas tabelas TMsgPri, TMsgAne.

Parâmetros:

company: Indica a empresa para processamento. Obrigatório.
\n
type: Tipo de mensagem. Obrigatório.
\n
- E = E-mail
  \n
- W = WhatsApp
  \n
- S = SMS (não implementado)
  \n
\n
module: Módulo de origem da mensagem. Opcional, default MN.
\n
- FC = Financeiro/Cobrança
  \n
- MN = Manual
  \n
- (ver domínio ORIMSG)
  \n
\n

Demais campos seuem o padrão de e-mail (/modus/email/send).

A mensagem será salva com o status \"A\". Acompanhamento da execução deve ser feito pelo log do agendador e pelo log de mensagens.