Versões comparadas

Chave

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

...

Formato SOAP/XMLFormato REST/JSON
Endpoints

http://<servidor>:<porta>/eai2-ws/EAIService?wsdl (DATASUL)

http://<servidor>:<porta>/EAISERVICE.apw?wsdl (LOGIX/PROTHEUS)

http://<servidor>:<porta>/EAIService/MEX?wsdl (RM)

  • Operação SOAP padrão para recebimento: receiveMessage

http://<servidor>:<porta>/totvseai/standardmessage/v1/transactions

http://<servidor>:<porta>/totvseai/standardmessage/v1/content

  • Endpoints implementados por todos os ERPs.

Estrutura da mensagem

TOTVSMessage, composta de:

  • MessageInformation
BusinessEventBusinessRequestBusinessContentResponseMessageReceiptMessage

...

  • e
  • BusinessMessage ou
  • ResponseMessage ou
  • ReceiptMessage

Dois atributos principais:

  • header
  • content

Não existe mais mensagem de recibo. O indicativo de que a mensagem foi recebida é o código HTTP 202 (Accepted).

Tags de MessageInformation X atributos de header
<MessageInformation version="2.000">"version" : "2.000"
<UUID>d6bbfa63-ca27-e2ac-0b14-101970f59a5b</UUID>"UUID" : "d6bbfa63-ca27-e2ac-0b14-101970f59a5b"
<Type>BusinessMessage</Type>"type" : "BusinessMessage"
<Transaction>CostCenter</Transaction>"transaction" : "CostCenter"
<StandardVersion>1.000</StandardVersion>Sem equivalente na mensagem. A versão do padrão será designada na URL do endpoint /totvseai/standardmessage/v1.
<SourceApplication>P1299</SourceApplication>"sourceApplication" : "P1299"
<CompanyId>99</CompanyId>"companyId" : "99"
<BranchId>01</BranchId>"branchId" : "01"
<UserId>admin<UserID>"userId" : "admin"
<Enterprise></Enterprise>Não será utilizado no formato REST/JSON
<BusinessUnit></BusinessUnit>Não será utilizado no formato REST/JSON.
<CompanySharingMode>C</CompanySharingMode>Não será utilizado no formato REST/JSON.
<BusinessUnitSharingMode>C</BusinessUnitSharingMode>Não será utilizado no formato REST/JSON.
<BranchSharingMode>C</BranchSharingMode>Não será utilizado no formato REST/JSON.
<Product name="PROTHEUS" version="12.1.17" />

"productName" : "PROTHEUS"

"productVersion" : "12.1.17"

<GeneratedOn>2017-11-15T12:00:30-02:00</GeneratedOn>"generatedOn" : "2017-11-15T12:00:30-02:00"
<DeliveryType>async</DeliveryType>"deliveryType" : "async"
Outras tags e suas equivalências no modelo REST/JSON
BusinessMessage/BusinessEvent

Atributo "subType" do header, com valor igual a "event".

Ex: "subType" : "event".

BusinessMessage/BusinessEvent/EntityUtilizar o atributo "transaction" do header.
BusinessMessage/BusinessEvent/Event

A operação será obtida do método HTTP usado no endpoint:

  • POST: será equivalente a <Event>upsert</Event>
  • DELETE: será equivalent a <Event>delete</Event>.
BusinessMessage/BusinessEvent/IdentificationNão será utilizado no formato REST/JSON.
BusinessMessage/BusinessRequest

Atributo "subType" do header com valor igual a "request".

Ex: "subType" : "request".