Histórico da Página

...

Documentar a estrutura, funcionamento e práticas relacionadas a à mensagem padronizada TOTVS utilizando REST como padrão de comunicação e JSON como formato de mensagem.

...

• É válido somente para mensagens assíncronas. Caso uma das mensagens presentes no lote tenha o atributo DeliveryType igual a "sync", todo o lote deve ser rejeitado.
• Pode conter mensagens de uma mesma transação e versão, ou mensagens de transações/versões distintas.
• A forma como o lote deve ser tratado quanto a sua atomicidade é determinada pelo parâmetro batchType, informado na requisição. Mais detalhes serão fornecidos na seção a seguirUm lote pode ser tratado como um simples agrupador de mensagens sem relação entre si, ou um lote transacional, onde as mensagens são interdependentes, representando uma única transação de negócio. Veja a descrição do parâmetro batchType, do predicado /transactions na seção a seguir, para mais informações.

Interface

As mensagens padronizadas em formato JSON serão recebidas por um endpoint padrão, conforme descrito abaixo:

/totvseai/standardmessage/v1/{resource}

Neste endpoint devem estar disponíveis dois predicados ou entidades:

No endpoint, v1 corresponde à versão do padrão de mensagem, que pode sofrer evolução futura. A versão será alterada, quando necessário, conforme o Guia de Implementação de APIs.

Em resource, pode-se informar as seguintes opções:

• /transactions: utilizado para receber mensagens que devem ser gerenciadas pelo Engine de EAI. As mensagens recebidas neste predicado devem ter, obrigatoriamente, um identificador único (UUID) e podem ser encaminhadas para uma fila, quando o modo de operação for assíncrono. É o equivalente à operação receiveMessage do padrão SOAP/XML.
• /contents: utilizado para receber mensagens onde apenas o conteúdo é relevante, e não há necessidade de maiores controles. Neste endpoint, o modo de operação será exclusivamente síncrono.

...