Mudanças entre as edições de "Manuais:UniNFe/EnviandoXMLMessageBroker"

De unimake
Ir para: navegação, pesquisa
(Adicionado documentação da tag <UseHomologServer>)
 
Linha 1: Linha 1:
 
__NOTITLE__
 
__NOTITLE__
−
=<font color=#2E8B57>'''Como utilizar o serviço do MessageBroker?'''</font>=
+
=<font color=#2E8B57>'''Como utilizar o serviço do uMessenger?'''</font>=
  
−
Após realizar a [[Manuais:UniNFe/ConfigurandoMessageBroker|configuração do MessageBroker no UniNFe]], vamos consumir o serviço, que consiste em dois micro serviços. Bora conferir?
+
Após realizar a [[Manuais:UniNFe/ConfigurandoMessageBroker|configuração do uMessenger no UniNFe]], vamos consumir o serviço de envio livre de mensagens. Bora conferir?
  
−
==<font color=#2E8B57>'''1º micro serviço: Notificação de boleto'''</font>==
+
==<font color=#2E8B57>'''Envio livre de mensagens'''</font>==
  
−
Seu ERP gerou um boleto e quer enviar para o cliente? Utilize esse serviço e como a comunicação no UniNFe é por transmissão de arquivos, criamos um [https://www.unimake.com.br/uninfe/modelos.php?p=MessageBroker exemplo em XML] de como você pode fazer isso. Para fazer o envio dessa notificação, basta gerar o arquivo na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de envio|pasta de envio]] com o nome e formato a seguir:
+
O serviço do UniNFe é consumido por meio da troca de arquivos. Criamos um [https://www.unimake.com.br/uninfe/modelos.php?p=MessageBroker exemplo em XML] para ilustrar esse processo. Para enviar, gere o arquivo na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de envio|pasta de envio]] com o nome e formato indicados a seguir.
  
−
Boleto_00000000000-mb.xml
+
MensagemASerEnviada-mb.xml
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
||Boleto_00000000000
+
||MensagemASerEnviada
 
||Conteúdo livre
 
||Conteúdo livre
 
|-
 
|-
Linha 19: Linha 19:
 
|}
 
|}
  
−
O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:
+
O nome do arquivo de retorno é o mesmo do arquivo enviado, alterando apenas o prefixo final, veja:
  
−
Boleto_00000000000-ret-mb.xml (''se tudo ocorreu bem'')
+
MensagemASerEnviada-ret-mb.xml (''se tudo ocorreu bem'')
  
 
ou
 
ou
  
−
Boleto_00000000000-ret-mb.err (''se houve algum erro'')
+
MensagemASerEnviada-ret-mb.err (''se houve algum erro'')
  
 
----
 
----
Linha 31: Linha 31:
 
===<font color=#2E8B57>Estrutura do XML de envio</font>===
 
===<font color=#2E8B57>Estrutura do XML de envio</font>===
  
−
A estrutura de envio é pequena, vamos conferir:
+
A estrutura de envio é compacta; vamos conferir.
  
 
<pre>
 
<pre>
 
<?xml version="1.0" encoding="utf-8"?>
 
<?xml version="1.0" encoding="utf-8"?>
−
<MessageBroker versao="1.00">
+
<uMessenger versao="1.00">
−
<BilletNotification>
+
  <SendTextMessage>
−
<BarCode>65465464646554456453456453456544565445645345654435</BarCode>
+
      <To>5544991423078</To>
−
<BilletNumber>12345678</BilletNumber>
+
      <Text>*Olá!*\r\n\r\nEu sou uma _mensagem_ de teste 🌜\r\n\r\n- Eu sou mais\r\n- Eu sou mais 1\r\n\r\nhttps://www.unimake.com.br</Text>
−
<CompanyName>Unimake Software</CompanyName>
+
      <Testing>true</Testing>
−
<ContactPhone>5544888889999</ContactPhone>
+
      <UseHomologServer>true</UseHomologServer>
−
<CustomerName>Joaquim</CustomerName>
+
  </SendTextMessage>
−
<Description>UniDANFe - Licença de 1 ano</Description>
+
</uMessenger>
−
<DueDate>04/07/2023</DueDate>
 
−
<QueryString>http://unimake.app.api/v1/pdf/download?Code=s65a4ds6a54ds6a4ds4ad54sa6d54as5dsa645d56sa4</QueryString>
 
−
<To>554491423078</To>
 
−
<Value>R$ 250,00</Value>
 
−
<Testing>true</Testing>
 
−
<UseHomologServer>true</UseHomologServer>
 
−
</BilletNotification>
 
−
</MessageBroker>
 
 
</pre>
 
</pre>
  
 
* <font color=#2E8B57>'''Legenda:'''</font>
 
* <font color=#2E8B57>'''Legenda:'''</font>
−
** A tag '''<BarCode>''' é código de barras do boleto sendo uma tag obrigatória;
 
−
** A tag '''<BillerNumber>''' é o número do boleto sendo uma tag obrigatória;
 
−
** A tag '''<CompanyName>''' é o nome da empresa que emitiu o boleto sendo uma tag obrigatória;
 
−
** A tag '''<ContactPhone>''' e o número do WhatsApp para que o destinatário entre em contato;
 
−
** A tag '''<CustomerName>''' é o nome do beneficiário/cliente ou destinatário do boleto sendo uma tag obrigatória;
 
−
** A tag '''<Description>''' é a descrição do que está sendo cobrado sendo uma tag obrigatória;
 
−
** A tag '''<DueDate>''' é a data da emissão da cobrança via boleto no formato DD/MM/AAAA sendo uma tag obrigatória;
 
−
** A tag '''<QueryString>''' é a informação adicional para download do boleto. O link para download sempre será o mesmo mudando apenas o '''''code''''', presente na URL, que é o token gerado no momento da criação do boleto;
 
 
** A tag '''<To>''' é o número do WhatsApp para onde será enviada a mensagem sendo uma tag obrigatória;
 
** A tag '''<To>''' é o número do WhatsApp para onde será enviada a mensagem sendo uma tag obrigatória;
−
** A tag '''<Value>''' é o valor do boleto tendo o separador decimal a vírgula (,) sendo uma tag obrigatória;
+
** A tag '''<Text>''' Texto livre a ser enviado ao destinatário da mensagem;
 
** A tag '''<Testing>''' é o que indica se é ambiente de teste ou não ('''True:''' ambiente de teste, '''False:''' ambiente de produção);
 
** A tag '''<Testing>''' é o que indica se é ambiente de teste ou não ('''True:''' ambiente de teste, '''False:''' ambiente de produção);
 
** A tag '''<UseHomologServer>''' é uma tag opcional no XML tendo o valor padrão <font color="#FF0000">'''false'''</font>. Só utilize quando é necessário fazer testes para possibilitar DEBUG do lado do eBank, naturalmente isso só pode ocorrer se um desenvolvedor do eBank solicitar esta tag no XML para facilitar depuração de código.
 
** A tag '''<UseHomologServer>''' é uma tag opcional no XML tendo o valor padrão <font color="#FF0000">'''false'''</font>. Só utilize quando é necessário fazer testes para possibilitar DEBUG do lado do eBank, naturalmente isso só pode ocorrer se um desenvolvedor do eBank solicitar esta tag no XML para facilitar depuração de código.
Linha 73: Linha 57:
 
Para verificar se a mensagem foi enviada, seu ERP deve verificar as informações no XML de retorno. Esse XML será gerado na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de retorno|pasta de retorno]] com o nome a seguir:
 
Para verificar se a mensagem foi enviada, seu ERP deve verificar as informações no XML de retorno. Esse XML será gerado na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de retorno|pasta de retorno]] com o nome a seguir:
  
−
Boleto_00000000000-ret-mb.xml
+
MensagemASerEnviada-ret-mb.xml
  
 
E sua estrutura é a seguinte:
 
E sua estrutura é a seguinte:
Linha 80: Linha 64:
 
<?xml version="1.0" encoding="utf-8"?>
 
<?xml version="1.0" encoding="utf-8"?>
 
<MessageBrokerResponse>
 
<MessageBrokerResponse>
−
<Status>1</Status>
+
  <Status>1</Status>
−
<Motivo>Mensagem enviada com sucesso.</Motivo>
+
  <Motivo>Mensagem enviada com sucesso.</Motivo>
−
<messageID>wamid.HBgMNTU0NDkxNDIzMDc4FQIAERgSMjAyQTNGMDczMjhGMUE0NTI1AA==</messageID>
+
  <messageID>wamid.HBgMNTU0NDkxNDIzMDc4FQIAERgSMjAyQTNGMDczMjhGMUE0NTI1AA==</messageID>
−
</MessageBrokerResponse>
 
−
</pre>
 
−
 
 
−
* <font color=#2E8B57>'''Legenda:'''</font>
 
−
** A tag '''<Status>''' é o status da mensagem tendo os valores:
 
−
*** 1 = Mensagem enviada com sucesso.
 
−
** A tag '''<Motivo>''' é a descrição do status;
 
−
** A tag '''<messageID>''' é o ID da mensagem enviada.
 
−
 
 
−
==<font color=#2E8B57>'''2º micro serviço: Notificação de PIX'''</font>==
 
−
 
 
−
Seu ERP gerou uma cobrança PIX e quer enviar para o cliente? Utilize esse serviço e como a comunicação no UniNFe é por transmissão de arquivos, criamos um [https://www.unimake.com.br/uninfe/modelos.php?p=MessageBroker exemplo em XML] de como você pode fazer isso. Para fazer o envio dessa notificação, basta gerar o arquivo na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de envio|pasta de envio]] com o nome e formato a seguir:
 
−
 
 
−
PIX_00000000000-mb.xml
 
−
 
 
−
{| class="wikitable"
 
−
|-
 
−
||PIX_00000000000
 
−
||Conteúdo livre
 
−
|-
 
−
| style="width: 120px;"|-mb.xml
 
−
||Conteúdo fixo. Sempre será "-mb.xml"
 
−
|}
 
−
 
 
−
O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:
 
−
 
 
−
PIX_00000000000-ret-mb.xml (''se tudo ocorreu bem'')
 
−
 
 
−
ou
 
−
 
 
−
PIX_00000000000-ret-mb.err (''se houve algum erro'')
 
−
 
 
−
----
 
−
 
 
−
===<font color=#2E8B57>Estrutura do XML de envio</font>===
 
−
 
 
−
A estrutura de envio é pequena, vamos conferir:
 
−
 
 
−
<pre>
 
−
<?xml version="1.0" encoding="utf-8"?>
 
−
<MessageBroker versao="1.00">
 
−
<PIXNotification>
 
−
<CopyAndPaste>00011111111111111111BR.GOV.BCB.PIX2222qrpix.ebank.solutions/qr/v2/11cff33aa-ffff-dff4-94d6-bb2611a0ded21312312312asdasd12331.022332BR2332UNIMAKE SOFTWARE***1233233E</CopyAndPaste>
 
−
<CompanyName>Unimake Software</CompanyName>
 
−
<ContactPhone>5544888889999</ContactPhone>
 
−
<CustomerName>Joaquim</CustomerName>
 
−
<Description>UniDANFe - Licença de 1 ano</Description>
 
−
<IssuedDate>04/07/2023</IssuedDate>
 
−
<QueryString>http://unimake.app.api/v1/pdf/download?Code=s65a4ds6a54ds6a4ds4ad54sa6d54as5dsa645d56sa4</QueryString>
 
−
<To>554491423078</To>
 
−
<Value>R$ 250,00</Value>
 
−
<Testing>true</Testing>
 
−
<UseHomologServer>true</UseHomologServer>
 
−
</PIXNotification>
 
−
</MessageBroker>
 
−
</pre>
 
−
 
 
−
* <font color=#2E8B57>'''Legenda:'''</font>
 
−
** A tag '''<CopyAndPaste>''' é o código do PIX para pagamento com copiar e colar sendo uma tag obrigatória;
 
−
** A tag '''<CompanyName>''' é o nome da empresa que gerou a cobrança PIX sendo uma tag obrigatória;
 
−
** A tag '''<ContactPhone>''' e o número do WhatsApp para que o destinatário entre em contato;
 
−
** A tag '''<CustomerName>''' é o nome do beneficiário/cliente ou destinatário da cobrança PIX sendo uma tag obrigatória;
 
−
** A tag '''<Description>''' é a descrição do que está sendo cobrado sendo uma tag obrigatória;
 
−
** A tag '''<IssuedDate>''' é a data da emissão da cobrança via PIX no formato DD/MM/AAAA sendo uma tag obrigatória;
 
−
** A tag '''<QueryString>''' é a informação adicional para pagamento via QRCode. O link para download sempre será o mesmo mudando apenas o '''''code''''', presente na URL, que é o token gerado no momento da criação da cobrança PIX;
 
−
** A tag '''<To>''' é o número do WhatsApp para onde será enviada a mensagem sendo uma tag obrigatória;
 
−
** A tag '''<Value>''' é o valor da cobrança PIX tendo o separador decimal a vírgula (,) sendo uma tag obrigatória;
 
−
** A tag '''<Testing>''' é o que indica se é ambiente de teste ou não ('''True:''' ambiente de teste, '''False:''' ambiente de produção);
 
−
** A tag '''<UseHomologServer>''' é uma tag opcional no XML tendo o valor padrão <font color="#FF0000">'''false'''</font>. Só utilize quando é necessário fazer testes para possibilitar DEBUG do lado do eBank, naturalmente isso só pode ocorrer se um desenvolvedor do eBank solicitar esta tag no XML para facilitar depuração de código.
 
−
 
 
−
----
 
−
 
 
−
===<font color=#2E8B57>XML de retorno do envio: O que fazer?</font>===
 
−
 
 
−
Para verificar se a mensagem foi enviada, seu ERP deve verificar as informações no XML de retorno. Esse XML será gerado na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de retorno|pasta de retorno]] com o nome a seguir:
 
−
 
 
−
PIX_00000000000-ret-mb.xml
 
−
 
 
−
E sua estrutura é a seguinte:
 
−
 
 
−
<pre>
 
−
<?xml version="1.0" encoding="utf-8"?>
 
−
<MessageBrokerResponse>
 
−
<Status>1</Status>
 
−
<Motivo>Mensagem enviada com sucesso.</Motivo>
 
−
<messageID>wamid.HBgMNTU0NDkxNDIzMDc4FQIAERgSOUYwNzNDMDA3Q0EwMUM3REVBAA==</messageID>
 
 
</MessageBrokerResponse>
 
</MessageBrokerResponse>
 
</pre>
 
</pre>

Edição atual tal como às 09h05min de 5 de agosto de 2024

Como utilizar o serviço do uMessenger?

Após realizar a configuração do uMessenger no UniNFe, vamos consumir o serviço de envio livre de mensagens. Bora conferir?

Envio livre de mensagens

O serviço do UniNFe é consumido por meio da troca de arquivos. Criamos um exemplo em XML para ilustrar esse processo. Para enviar, gere o arquivo na pasta de envio com o nome e formato indicados a seguir.

MensagemASerEnviada-mb.xml

MensagemASerEnviada Conteúdo livre
-mb.xml Conteúdo fixo. Sempre será "-mb.xml"

O nome do arquivo de retorno é o mesmo do arquivo enviado, alterando apenas o prefixo final, veja:

MensagemASerEnviada-ret-mb.xml (se tudo ocorreu bem)

ou

MensagemASerEnviada-ret-mb.err (se houve algum erro)

Estrutura do XML de envio

A estrutura de envio é compacta; vamos conferir. 

<?xml version="1.0" encoding="utf-8"?>
<uMessenger versao="1.00">
   <SendTextMessage>
      <To>5544991423078</To>
      <Text>*Olá!*\r\n\r\nEu sou uma _mensagem_ de teste 🌜\r\n\r\n- Eu sou mais\r\n- Eu sou mais 1\r\n\r\nhttps://www.unimake.com.br</Text>
      <Testing>true</Testing>
      <UseHomologServer>true</UseHomologServer>
   </SendTextMessage>
</uMessenger>
  • Legenda:
    • A tag <To> é o número do WhatsApp para onde será enviada a mensagem sendo uma tag obrigatória;
    • A tag <Text> Texto livre a ser enviado ao destinatário da mensagem;
    • A tag <Testing> é o que indica se é ambiente de teste ou não (True: ambiente de teste, False: ambiente de produção);
    • A tag <UseHomologServer> é uma tag opcional no XML tendo o valor padrão false. Só utilize quando é necessário fazer testes para possibilitar DEBUG do lado do eBank, naturalmente isso só pode ocorrer se um desenvolvedor do eBank solicitar esta tag no XML para facilitar depuração de código.

XML de retorno do envio: O que fazer?

Para verificar se a mensagem foi enviada, seu ERP deve verificar as informações no XML de retorno. Esse XML será gerado na pasta de retorno com o nome a seguir:

MensagemASerEnviada-ret-mb.xml

E sua estrutura é a seguinte: 

<?xml version="1.0" encoding="utf-8"?>
<MessageBrokerResponse>
   <Status>1</Status>
   <Motivo>Mensagem enviada com sucesso.</Motivo>
   <messageID>wamid.HBgMNTU0NDkxNDIzMDc4FQIAERgSMjAyQTNGMDczMjhGMUE0NTI1AA==</messageID>
</MessageBrokerResponse>
  • Legenda:
    • A tag <Status> é o status da mensagem tendo os valores:
      • 1 = Mensagem enviada com sucesso.
    • A tag <Motivo> é a descrição do status;
    • A tag <messageID> é o ID da mensagem enviada.

Veja também

Disponível em "http://wiki.unimake.com.br/index.php?title=Manuais:UniNFe/EnviandoXMLMessageBroker&oldid=5475"