Você está na página 1de 7

ESPECIFICAÇÃO DO

SERVIÇO DE INTEGRAÇÃO
ENTRE OS SISTEMAS
SISTER E PROTHEUS

Versões

Versão Data Revisão Autor


1.0 02/09/2018 Eduardo Valeriano
1.1 05/09/2018 Inclusão das classes Eduardo Valeriano
1.2 01/10/2018 Inclusão do Método de Cancelamento de Baixa Eduardo Valeriano

1
Sumário
Sobre este Documento ..................................................................................................................................................... 3
Breve descrição do projeto ............................................................................................................................................... 4
Características Técnicas .................................................................................................................................................... 4
Descrição do Serviço ......................................................................................................................................................... 5
Endereço ........................................................................................................................................................................... 5
Métodos: ........................................................................................................................................................................... 6
Classe de Retorno ............................................................................................................................................................. 7
Classe de Nota Baixada ..................................................................................................................................................... 7
Classe de Nota Cancelada ................................................................................................................................................. 7
Classe de Cancelamento de Nota Baixada ........................................................................................................................ 7

2
Sobre este Documento

O objetivo deste documento, é prover as informações necessárias para o acesso e uso do


WebService de integração SISTER/PROTHEUS

3
Breve descrição do projeto

O projeto em questão visa fazer a integração do módulo financeiro do ERP do Protheus, com o
sistema de gestão de vistoria e manutenção dos contêineres, neste caso o SISTER. Para
possibilitar está integração, a eProfessionalTI desenvolveu um Webservice composto de três
métodos, que serão descritos em seguida.

Características Técnicas
O Webservice, foi desenvolvido na plataforma Visual Studio .Net 2015 da Microsoft, usando como
linguagem base o Visual Basic e banco de dados o SQL Server 2012. Este Webservice será
hospedado em um servidor web também baseado na plataforma Microsoft, neste caso o IIS 7.5
( Internet Information Services).

4
WEBSERVICE
Descrição do Serviço
O serviço de integração, será fornecido por um Webservice denominado Integração/Sister, este
serviço, estará disponível no seguinte link, para teste:

Endereço
HTTP://187.60.29.29/WEBINTEGRASUPER/SISTER.SVC

Neste link, será disponibilizado os quatro métodos, sendo um para informar a baixa da Fatura/RPS, outro para
informar o cancelamento de uma Fatura/RPS, outro para Cancelamento da Baixa de uma Nota e um método para
testar o Webservice. Vale ressaltar, que é o Webservice irá trabalhar de forma síncrona nos três métodos

5
Métodos:

Método para testar o WebService

TesteServico() As String

O método retorna um texto com os dados do WebService, usado para identificar se o Webservice está ativo e
responsivo/reativo.

Método para Baixa da Nota/RPS:


BaixaNota(NotaBaixa As CNotaBaixa) As RetornoMensagem

O método espera um objeto do tipo CNotaBaixa, verificar a seção Modelagem de Dados.


O método é responsável pela inclusão da Baixa da Nota/RPS dentro do SISTER.
Para efetuar a Baixa, é necessário que a nota seja válida e que não tenha sido cancelada.
Todos os campos são obrigatórios.

Método para Cancelamento da Nota/RPS:


CancelaNota(NotaCancel As CNotaCancel) As RetornoMensagem

O método espera um objeto do tipo CNotaCancel, verificar a seção Modelagem de Dados.


O método é responsável pelo Cancelamento da Nota/RPS dentro do SISTER.
Para efetuar o Cancelamento, é necessário que a nota seja válida e que não tenha sido baixada.
Todos os campos são obrigatórios.

Método para Cancelamento Baixa da Nota/RPS:


CancelaBaixa(CancBaixa As CCancBaixa) As RetornoMensagem

O método espera um objeto do tipo CCancBaixa, verificar a seção Modelagem de Dados.


O método é responsável pelo Cancelamento da baixa da Nota/RPS dentro do SISTER.
Para efetuar o Cancelamento, é necessário que a nota seja válida e que já tenha sido baixada.
Todos os campos são obrigatórios.

6
MODELAGEM DE DADOS
Classe de Retorno
Nome: RetornoMensagem
Campos Tipo Descrição
FlagSucesso Boolean Indica se houve sucesso ou se o processo falhou
MensagemErro String Mensagem de erro quando ocorrer
CodigoErro String Código do erro quando ocorrer

Classe de Nota Baixada


Nome: CNotaBaixa
Campos Tipo Tamanho Descrição
CodigoNota String 15 Código da Nota no SISTER
NotaRPS String 9 Número do RPS
SerieRPS String 2 Série do RPS
NotaPrefeitura String 9 Número da nota na Prefeitura
StatusPrefeitura String 1 Status da nota na Prefeitura
MensagemPrefeitura String 100 Mensagem da Prefeitura
DataBaixa Datetime Data da Baixa

Classe de Nota Cancelada


Nome: CNotaCancel
Campos Tipo Tamanho Descrição
CodigoNota String 15 Código da Nota no SISTER
NotaRPS String 9 Número do RPS
SerieRPS String 2 Série do RPS
NotaPrefeitura String 9 Número da nota na Prefeitura
StatusPrefeitura String 1 Status da nota na Prefeitura
MotivoCancelamento String 200 Mensagem da Prefeitura
DataCancelamento Datetime Data do Cancelamento

Classe de Cancelamento de Nota Baixada


Nome: CNotaBaixa
Campos Tipo Tamanho Descrição
CodigoNota String 15 Código da Nota no SISTER
NotaRPS String 9 Número do RPS
SerieRPS String 2 Série do RPS
NotaPrefeitura String 9 Número da nota na Prefeitura
Justificativa String 100 Justificativa para o Cancelamento da Baixa
DataBaixa Datetime Data da Baixa da Nota

Você também pode gostar