Mudanças

Ir para: navegação, pesquisa

Manuais:UniNFe/EnviandoXMLMessageBroker

5 873 bytes removidos, 5 agosto
sem sumário de edição
__NOTITLE__
=<font color=#2E8B57>'''Como utilizar o serviço do MessageBrokeruMessenger?'''</font>=
Após realizar a [[Manuais:UniNFe/ConfigurandoMessageBroker|configuração do MessageBroker uMessenger no UniNFe]], vamos consumir o serviço, que consiste em dois micro serviçosde envio livre de mensagens. Bora conferir?
==<font color=#2E8B57>'''1º micro serviço: Notificação Envio livre de boletomensagens'''</font>==
Seu ERP gerou um boleto e quer enviar para o cliente? Utilize esse O serviço e como a comunicação no do UniNFe é consumido por transmissão meio da troca de arquivos, criamos . Criamos um [https://www.unimake.com.br/uninfe/modelos.php?p=MessageBroker exemplo em XML] de como você pode fazer issopara ilustrar esse processo. Para fazer o envio dessa notificaçãoenviar, basta gerar 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_00000000000MensagemASerEnviada-mb.xml
{| class="wikitable"
|-
||Boleto_00000000000MensagemASerEnviada
||Conteúdo livre
|-
|}
O nome do arquivo de retorno é o mesmo do envioarquivo enviado, mudando somente a extensão (alterando apenas o prefixo final) do mesmo, conforme abaixoveja:
Boleto_00000000000MensagemASerEnviada-ret-mb.xml (''se tudo ocorreu bem'')
ou
Boleto_00000000000MensagemASerEnviada-ret-mb.err (''se houve algum erro'')
----
===<font color=#2E8B57>Estrutura do XML de envio</font>===
A estrutura de envio é pequena, compacta; vamos conferir:.
<pre>
<?xml version="1.0" encoding="utf-8"?>
<MessageBroker uMessenger versao="1.00"> <BilletNotificationSendTextMessage> <BarCodeTo>654654646465544564534564534565445654456453456544355544991423078</BarCodeTo> <BilletNumberText>12345678</BilletNumber> <CompanyName>Unimake Software</CompanyName> <ContactPhone>5544888889999</ContactPhone> <CustomerName>Joaquim</CustomerName> <Description>UniDANFe *Olá!*\r\n\r\nEu sou uma _mensagem_ de teste 🌜\r\n\r\n- Eu sou mais\r\n- Licença de Eu sou mais 1 ano</Description> <DueDate>04/07/2023</DueDate> <QueryString>http\r\n\r\nhttps://www.unimake.appcom.api/v1/pdf/download?Code=s65a4ds6a54ds6a4ds4ad54sa6d54as5dsa645d56sa4</QueryString> <To>554491423078</To> <Value>R$ 250,00br</ValueText> <Testing>true</Testing> <UseHomologServer>true</UseHomologServer> </BilletNotificationSendTextMessage></MessageBrokeruMessenger>
</pre>
* <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 '''<ValueText>''' é o valor do boleto tendo o separador decimal Texto livre a vírgula (,) sendo uma tag obrigatóriaser 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 <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.
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_00000000000MensagemASerEnviada-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></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>
</pre>

Menu de navegação