Histórico da Página

Segue abaixo o link onde contém explicações detalhadas sobre a mensagem padronizada:

• Padrão para criação de Mensagem Padronizada

Com o objetivo de padronizar as integrações com os produtos TOTVS, foi definida uma nova diretriz para os projetos de integração onde todos os produtos TOTVS devem se comunicar através de mensagem XML ou JSON única, evitando desta forma, o processo de transformação de mensagens. O layout completo da mensagem padronizada conta com cabeçalho e elementos com informações de origem e destino, status de processamento e erros. Isto permite que dentro de uma mensagem específica seja definido apenas o conteúdo de negócio e retorno, mas quando o XML ou JSON completo for trafegar entre os produtos, todas as informações citadas anteriormente também façam parte da estrutura da mensagem.

Segue abaixo um exemplo do XML de uma mensagem padronizada (XML) completa:

Image Removed

Exemplo de um XML de resposta de processamento sem erros:

Image Removed

Exemplo de um XML de resposta de processamento com erros:

Image Removed

Exemplo de um XML de ReceiptMessage:

Image Removed

Observação: Uma ReceiptMessage representa a confirmação de recebimento de uma BusinessMessage pelo aplicativo destino. Diferente da ResponseMessage, uma ReceiptMessage não irá conter qualquer informação relevante sobre o processamento da mensagem. O envio da ReceiptMessage deverá ocorrer somente no envio de mensagem no modo assíncrona.

Informações Comuns

As mensagens TOTVS possuem um segmento chamado MessageInformation que possui as principais informações utilizadas para identificação e roteamento da mensagem. Segue abaixo um exemplo:

Image Removed

A seguir é apresentado uma descrição detalhada de cada item ilustrado acima:

MessageInformation version: Identifica qual a versão da mensagem de negócio. Uma mensagem de Item, por exemplo, pode sofrer alterações no decorrer do tempo, sendo que cada uma destas alterações irá afetar esta informação;

UUID: Identificador único da mensagem e que não pode ser igual ao UUID de qualquer outra mensagem em qualquer um dos aplicativos participantes da integração;

Type: Identifica o tipo da mensagem (BusinessMessage ou ResponseMessage);

Transaction: Identificador do tipo de transação da mensagem. Esta informação será utilizada pelos aplicativos para definir como os dados serão processados no recebimento;

StandardVersion: Identifica a versão do padrão TOTVS, ou seja, do formato utilizado nas áreas genéricas da mensagem TOTVS. Caso o padrão TOTVS seja alterado, este valor será alterado;

SourceApplication: Identifica a instância dos aplicativos que gerou a mensagem. Uma instância representa uma instalação/configuração daquele aplicativo/produto. Caso duas instâncias do mesmo aplicativo participem da mesma integração, cada uma deverá ser identificada de forma única;

CompanyId/BranchId/UserId: Identificador da empresa/filial e usuário que gerou a mensagem (obrigatória);

Product: Identifica o produto e versão do aplicativo que originou a mensagem. Neste caso, o valor pode ser igual, mesmo em instâncias diferentes do mesmo aplicativo;

GeneratedOn: Identifica o timestamp de geração desta mensagem;

...