Page History

Estamos em Devido ao processo de migrar todas as nossas migração das mensagens padronizadas para o formato JSON. Consequentemente, também estamos adaptando os , e consequentemente, a adaptação dos EAIs que as utilizam. Durante esse período de transição, faz, fez-se necessária a existência de uma camada de conversão automática até que a migração esteja completa.

Para atender essa necessidade, disponibilizamos esse serviço via API REST no http://api.totvs.com.br, através dos seguintes endpoints: 

• /XMLToJSON
• /JSONToXML

O conversor recebe uma mensagem em XML e a retorna na nova estrutura definida em JSON, e vice-versa. Estão disponibilizados dois métodos públicos estáticos na classe Conversor: 

...

Convertendo de XML para JSON 

http://api.totvs.com.br:8082/api/totvseai/Converter/v1/XMLToJSON

Realizar uma requisição através do verbo POST na URL acima, enviando o XML no corpo. A resposta será o seu valor correspondente convertido em JSON.

O cabeçalho "Content-Type" deve ser definido como "Text-Plain". A resposta obtida também será  "Text-Plain".

Exemplo Requisição:

POST http://api.totvs.com.br:8082/api/totvseai/Converter/v1/XMLToJSON
Content-Type: text/plain
Body Request: 
<TOTVSMessage>
	<MessageInformation version="1.001">
		<UUID>c18535da-75b8-4925-9e32-b6445d4f2927</UUID>
		<Type>BusinessMessage</Type>
		<Transaction>Warehouse</Transaction>
		<StandardVersion>1.001</StandardVersion>
		<SourceApplication>RM</SourceApplication>
		<CompanyId>2</CompanyId>
		<BranchId>2</BranchId>
		<Product name="RM" version="11.83.55" />
		<GeneratedOn>2016-06-21T19:41:21</GeneratedOn>
		<DeliveryType>Sync</DeliveryType>
	</MessageInformation>
	<BusinessMessage>
		<BusinessEvent>
			<Entity>Warehouse</Entity>
			<Event>upsert</Event>
		</BusinessEvent>
		<BusinessContent>
			<CompanyId>CompanyId1</CompanyId>
			<BranchId>BranchId1</BranchId>
			<CompanyInternalId>CompanyInternalId1</CompanyInternalId>
			<Code>Code1</Code>
			<InternalId>InternalId1</InternalId>
			<Description>Description1</Description>
			<Active>true</Active>
			<Type>1</Type>
			<IsFinalItem>true</IsFinalItem>
			<IsQualityControl>true</IsQualityControl>
			<IsProcess>true</IsProcess>
			<IsWaste>true</IsWaste>
			<IsRecycled>true</IsRecycled>
			<IsBalanceAvailable>true</IsBalanceAvailable>
			<WarehouseClassification>1</WarehouseClassification>
		</BusinessContent>
	</BusinessMessage>
</TOTVSMessage>

Exemplo Resposta:

POST http://api.totvs.com.br:8082/api/totvseai/Converter/v1/XMLToJSON
Content-Type: text/plain
Body Response: 
{"Header":{"UUID":"c18535da-75b8-4925-9e32-b6445d4f2927","Type":"BusinessMessage","Transaction":"Warehouse","StandardVersion":"1.001","SourceApplication":"RM","CompanyId":"2","BranchId":"2","GeneratedOn":"2016-06-21T19:41:21","DeliveryType":"Sync","Version":"1.001","ProductName":"RM","ProductVersion":"11.83.55"},"Content":{"CompanyId":"CompanyId1","BranchId":"BranchId1","CompanyInternalId":"CompanyInternalId1","Code":"Code1","InternalId":"InternalId1","Description":"Description1","Active":true,"Type":1,"IsFinalItem":true,"IsQualityControl":true,"IsProcess":true,"IsWaste":true,"IsRecycled":true,"IsBalanceAvailable":true,"WarehouseClassification":1}}

Convertendo de JSON para XML

http://api.totvs.com.br:8082/api/totvseai/Converter/v1/JSONToXML/?tagevent=upsert|delete|request

Realizar uma requisição através do verbo POST na URL acima, enviando o JSON no corpo. A resposta será o seu valor correspondente convertido em XML.

O cabeçalho "Content-Type" deve ser definido como "Text-Plain". A resposta obtida também será  "Text-Plain".

Nesse caso, também é preciso especificar qual é o evento da mensagem (Para ser o valor da tag <event></event), no parâmetro de query tagevent, evidenciado na URL. 
Os possíveis valores são:

• Upsert
• Delete
• Request 

Exemplo Requisição:

Download da DLL do conversor

Trata-se de uma DLL desenvolvida em .Net CORE, e portanto pode ser importada em qualquer programa que tenha suporte para tal.

StandardMessageConversor.dll

Importando o Conversor em um projeto .Net

• Clique direito em "Dependencies" → "Add Reference"

Image Removed 

• Clicar em "Browse..."

Image Removed

• Buscar a DLL do conversor (StandardMessageConversor.dll).

Image Removed

• Agora já adicionamos a referência ao Conversor. 
• A próxima etapa é adicionar o Newtonsoft.Json. É possível fazer esse processo através do NuGet.
• Clique direito no projeto → "Manage NuGet Packages"    

Image Removed

• Buscar Newtonsoft.Json.
• Clicar em "Install" para instalar o pacote no projeto.

Image Removed

• O conversor está importado e pronto para uso.

Importando o Conversor em um projeto ADVPL

Para projetos em ADVPL, precisa ser utilizada a versão 9.0.1. do Newtonsoft

Importando o Conversor em um projeto Progress

Convertendo de XML para JSON 

POST  string generatedMsg = Conversor.ConvertXMLToJSON(message);http://api.totvs.com.br:8082/api/totvseai/Converter/v1/JSONToXML/?tagevent=upsert
Content-Type: text/plain
Body Request: 
{"Header":{"UUID":"c18535da-75b8-4925-9e32-b6445d4f2927","Type":"BusinessMessage","Transaction":"Warehouse","StandardVersion":"1.001","SourceApplication":"RM","CompanyId":"2","BranchId":"2","GeneratedOn":"2016-06-21T19:41:21","DeliveryType":"Sync","Version":"1.001","ProductName":"RM","ProductVersion":"11.83.55"},"Content":{"CompanyId":"CompanyId1","BranchId":"BranchId1","CompanyInternalId":"CompanyInternalId1","Code":"Code1","InternalId":"InternalId1","Description":"Description1","Active":true,"Type":1,"IsFinalItem":true,"IsQualityControl":true,"IsProcess":true,"IsWaste":true,"IsRecycled":true,"IsBalanceAvailable":true,"WarehouseClassification":1}}

Exemplo Resposta:

    /// <summary>
    /// Recebe uma mensagem padronizada em XML e a retorna em JSONPOST http://api.totvs.com.br:8082/api/totvseai/Converter/v1/JSONToXML/?tagevent=upsert
Content-Type: text/plain
Body Request: 
<?xml version="1.0" encoding="utf-8"?>
<TOTVSMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MessageInformation version="1.001">
    <UUID>c18535da-75b8-4925-9e32-b6445d4f2927</UUID>
    <Type>BusinessMessage</Type>
    <Transaction>Warehouse</Transaction>
    <StandardVersion>1.001</StandardVersion>
    <SourceApplication>RM</SourceApplication>
    <<CompanyId>2</summary>CompanyId>
    /// <param<BranchId>2</BranchId>
    <Product name="messageRM">Mensagem no formato XML</param> version="11.83.55" />
    /// <returns>Mensagem padronizada no formato JSON</returns>
    public static string ConvertXMLToJSON(string message);

Convertendo de JSON para XML

  string generatedMsg = Conversor.ConvertJSONToXML(message, "upsert");

     /// <summary><GeneratedOn>2016-06-21T19:41:21</GeneratedOn>
    <DeliveryType>Sync</DeliveryType>
  </MessageInformation>
  <BusinessMessage>
    <BusinessEvent>
      <Entity>Warehouse</Entity>
      <Event>upsert</Event>
    <///BusinessEvent>
 Recebe uma mensagem padronizada<BusinessContent>
 em JSON e a retorna em XML
<CompanyId>CompanyId1</CompanyId>
     /// <<BranchId>BranchId1</summary>BranchId>
    /// <param name="message"> Mensagem no formato JSON</param>
  <CompanyInternalId>CompanyInternalId1</CompanyInternalId>
      <Code>Code1</Code>
      /// <param name="restVerb"> Verbo em que a mensagem foi recebida pela API Rest. Exemplos: "upsert", "delete". 
    /// O valor colocado nessa variavel será apresentado no elemento Event de BusinessEvent
    /// </param>
    /// <returns>Mensagem padronizada no formato XML</returns>
    public static string ConvertJSONToXML(string message, string restVerb);<InternalId>InternalId1</InternalId>
      <Description>Description1</Description>
      <Active>true</Active>
      <Type>1</Type>
      <IsFinalItem>true</IsFinalItem>
      <IsQualityControl>true</IsQualityControl>
      <IsProcess>true</IsProcess>
      <IsWaste>true</IsWaste>
      <IsRecycled>true</IsRecycled>
      <IsBalanceAvailable>true</IsBalanceAvailable>
      <WarehouseClassification>1</WarehouseClassification>
    </BusinessContent>
  </BusinessMessage>
</TOTVSMessage>

Transações suportadas

Abaixo encontram-se as transações que estão sendo suportadas pelo conversor.