Índice:

Introdução:

        O serviço do Totvs Mashups permite a integração de qualquer aplicativo de qualquer sistema operacional e linguagem de programação.

        A sua implementação foi feita em cima da WCF (Windows Communication Foundation) utilizando padrão WS-*, XML e SOAP para a comunicação. Mas expansível a outros padrões suportados pela WCF, da plataforma Microsoft.NET.

        Neste documento estão detalhados todos os métodos disponíveis e classes usadas para a comunicação com o WebService.

        A definição do WebService está disponível em: http://mashups.totvs.com.br/TotvsSOA.Host/SOAManager.svc?wsdl

Métodos Disponíveis no WebService:

      GetServiceTypes:

        Através         Através desta função é possível obter uma lista dos tipos de Mashups disponíveis. Na arquitetura do Totvs Mashups, podem ser criados vários tipos diferentes Mashups, tais como:

• MashupStudioService – Mashups criados com a ferramenta Mashup Studio
• MetadataService – Serviços de informações dos Mashups
• WebServices – Mashups baseados em WebServices

              Parâmetros: (SOAConnectionData)
         Resultados: Array de strings com a lista de ServiceTypes.  

 Classe: SOAConnectionData

• ClientID: String – ID do Client do Totvs Mashups
• UserName: String – Nome do usuário do Totvs Mashups
• Password: String – Senha do usuário

      GetServiceNames:

              Através desta função é possível obter uma lista dos Mashups disponíveis para o ServiceType selecionado. Cada ServiceType pode ter vários Mashups publicados.

         Parâmetros: (SOAConnectionData; ServiceType: String)
         Resultados: Array de strings com a lista de Mashups.

      GetServicesInfo:

              Através desta função é possível obter uma lista com detalhes dos Mashups disponíveis para o SearchType e SearchValue informados. Esta função retorna diversas informações sobre os Mashups que estão definidas na classe SOAServiceInfo.

         Parâmetros:

• SOAConnectionData
• SearchType: Enumerado (All, ServiceName, ServiceTitle, Description, Provider, Tag)
• SearchValue: String

         Resultados: Array de SOAServiceInfo.

     Classe: SOAServiceInfo

• ServiceType: String – Tipo de serviço do Mashup
• ServiceName: String – Nome do Mashup
• ServiceVersion: Integer – Versão do Mashup
• ServiceTitle: String – Título do Mashup
• ServiceProvider: String – Provedor dos dados do Mashup
• ServiceDescription: String – Descrição detalhada do Mashup
• ServiceTags: Strings – Tags relacionadas ao Mashup
• ServiceDate: DateTime – Data da publicação/alteração do Mashup