Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

A mensagem padronizada utilizando JSON como formato terá as seguintes características:<Descrever o JSON de mensagem padronizada>

Header: contem informações equivalentes a tag MessageInformation, entre elas:

  • UUID
  • Type
  • Transaction
  • StandardVersion
  • SourceApplication
  • ProductName
  • ProductVersion
  • GeneratedOn
  • DeliveryType

Content: contem informações equivalentes a tag BusinessContent, para mensagens de negócio, ou a tag ReturnContent, para mensagens de resposta. Devido a isso, os atributos podem variar de acordo com a definição da transação.

Interface

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

/totvseai/standardmessage/v1/receive/{transactionID}

Os métodos HTTP previstos para o endpoint são:

  • PUT: para mensagens de inclusão ou alteração (upsert). Corresponde as mensagens XML contendo a tag BusinessEvent, com Event igual a upsert.
  • POST: para mensagens de requisição (request). Corresponde as mensagens XML contendo a tag BusinessRequest.
  • DELETE: para mensagens de eliminação (delete). Corresponde as mensagens XML contendo a tag BusinessEvent, com Event igual a delete.

Coexistência com o formato XML/SOAP

No período de migração das implementações em XML para JSON, será necessário que os formatos convivam simultaneamente e sejam interoperáveis. Assim que todos os ERPs forem capazes de trabalhar com a nova proposta, o formato XML e os endpoints SOAP poderão ser desativados.

Elaboração da mensagem padronizada

O desenho de uma transação, na nova proposta, utilizará o formato Swagger/OpenAPI, em substituição ao formato XML Schema, utilizado na implementação original.