LCPManager - Web Service de importação de LCP

Documentação
1

Neste tópico, vamos apresentar o Web Service de importação de arquivos LCP.

Arquivos LCP (Latromi Content Package) são usados para exportar os objetos desenvolvidos com o Latromi, e importá-los em outros ambientes. É um arquivo de integração.

Estes arquivos podem ser exportados e importados manualmente usando Latromi Client.

Mas… se você está desenvolvendo um sistema que será distribuídos para os seus clientes, fazer a atualização manual de cada arquivo LCP sempre que houver uma atualização do seu sistema, pode ser uma tarefa árdua.

Com este serviço, é possível desenvolver programas para automatizar a atualização dos arquivos LCP.

A propriedade Endereço de todos os serviços apresentados nessa página, é um caminho relativo, e deve ser precedido da URL base do site. O endereço base usado nos exemplos será http://localhost:8081/web

Usando Visual Studio

Os serviços SOAP (Simple Object Access Protocol) listados neste tópico podem ser referenciados no Visual Studio usando o recurso “Add Service Reference”. Dessa forma não é necessário se preocupar com a estrutura do XML pois serão criadas classes para fazer a Serialização/Deserialização dos dados.

image
Visual Studio - Add Service Reference617×504 11.2 KB

Caso esteja usando outra ferramenta, sigas as instruções baixo.

Soap 1.2

Web Service usando SOAP versão 1.2.

ImportPackage

Serviço para importar o arquivo LCP binário (blob).

Propriedade Valor
Endereço /services/LCPManager.svc
Método ImportPackage
Namespace http://latromi.com.br/localsvc/soap
Action http://latromi.com.br/localsvc/soap/LCPManager/ImportPackage
Parâmetros Descrição
integrationKey Chave de integração
packageFile Arquivo LCP, no formato Base64

Exemplo

POST: http://localhost:8081/web/services/LCPManager.svc 
Content-Type: application/soap+xml; charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <soap:Header>
      <a:Action>http://latromi.com.br/localsvc/soap/LCPManager/ImportPackage</a:Action>
      <a:To>http://localhost:8081/web/Services/LCPManager.svc</a:To>
   </soap:Header>
   <soap:Body>
      <ImportPackage xmlns="http://latromi.com.br/localsvc/soap">
         <integrationKey>eae672ea15b5fe2cf870270545edd37d</integrationKey>
         <packageFile>UEsDBBQAAAAIA.........</packageFile>
      </ImportPackage>
   </soap:Body>
</soap:Envelope>

ImportPackageByUri

Serviço para importar o arquivo LCP através do caminho físico ou URL.

Propriedade Valor
Endereço /services/LCPManager.svc
Método ImportPackageByUri
Namespace http://latromi.com.br/localsvc/soap
Action http://latromi.com.br/localsvc/soap/LCPManager/ImportPackageByUri
Parâmetros Descrição
integrationKey Chave de integração
packageUri URL ou Caminho Físico do arquivo no servidor 
POST: http://localhost:8081/web/services/LCPManager.svc 
Content-Type: application/soap+xml; charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <soap:Header>
      <a:Action>http://latromi.com.br/localsvc/soap/LCPManager/ImportPackageByUri</a:Action>
      <a:To>http://localhost:8081/web/Services/LCPManager.svc</a:To>
   </soap:Header>
   <soap:Body>
      <ImportPackageByUri xmlns="http://latromi.com.br/localsvc/soap">
         <integrationKey>eae672ea15b5fe2cf870270545edd37d</integrationKey>
         <packageUri>https://latromi.com.br/downloads/lcp/LATROMI%20Tools.lcp</packageUri>
      </ImportPackageByUri>
   </soap:Body>
</soap:Envelope>

SOAP 1.1

Web Service que utiliza uma versão mais antiga do SOAP, para integrar com linguagem que não suportam SOAP 1.2.

ImportPackage

Serviço para importar o arquivo LCP binário (blob).

Propriedade Valor
Endereço /services/LCPManagerBasic.svc
Método ImportPackage
Namespace http://latromi.com.br/localsvc/soap11
Action http://latromi.com.br/localsvc/soap11/LCPManagerBasic/ImportPackage
Parâmetros Descrição
integrationKey Chave de integração
packageFile Arquivo LCP, no formato Base64

Exemplo

POST: http://localhost:8081/web/services/LCPManagerBasic.svc 
Accept: text/xml
Content-Type: text/xml;charset="utf-8"
SOAPAction: http://latromi.com.br/localsvc/soap11/LCPManagerBasic/ImportPackage 

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ImportPackage xmlns="http://latromi.com.br/localsvc/soap11">
         <integrationKey>eae672ea15b5fe2cf870270545edd37d</integrationKey>
         <packageFile>UEsDBBQAAAAIA.........</packageFile>
      </ImportPackage>
   </soap:Body>
</soap:Envelope>

ImportPackageByUri

Serviço para importar o arquivo LCP através do caminho físico ou URL.

Propriedade Valor
Endereço /services/LCPManagerBasic.svc
Método ImportPackageByUri
Namespace http://latromi.com.br/localsvc/soap11
Action http://latromi.com.br/localsvc/soap11/LCPManagerBasic/ImportPackageByUri
Parâmetros Descrição
integrationKey Chave de integração
packageUri URL ou Caminho Físico do arquivo no servidor

Exemplo

POST: http://localhost:8081/web/services/LCPManagerBasic.svc 
Accept: text/xml
Content-Type: text/xml;charset="utf-8"
SOAPAction: http://latromi.com.br/localsvc/soap11/ImportPackageByUri/ImportPackage 

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ImportPackageByUri xmlns="http://latromi.com.br/localsvc/soap11">
         <integrationKey>eae672ea15b5fe2cf870270545edd37d</integrationKey>
         <packageUri>http://dl.latromi.com.br/lcp/LATROMI%20Essentials.lcp</packageUri>
      </ImportPackageByUri>
   </soap:Body>
</soap:Envelope>
1 curtida