RESTWeb Service REST

Produto:	TOTVS Prestadores de Serviços Transporte de Passageiros
Versões:	12.1.23102410+

Este documento tem o objetivo de fornecer informações para utilização do Web Service REST de integração com oTOTVS Prestadores de Serviços Transporte de Passageiros

Para mais detalhes sobre o conceito de um serviços REST clique aqui.

Para mais detalhes sobre serviços REST na arquitetura Protheus clique aqui.

Definição do Serviço

Nome: WSCOLETOR

Objetivo: Permitir a Integração com o módulo SIGAGTP utilizando um WebService do Tipo REST.

Descrição: Integra os dados do coletor para gerar a prestação de contas.

Métodos: POST

Configurações do Serviço

A Configuração do serviço REST está documentada no link Configuração REST SERVER - Protheus.

Estas parametrizações estão localizadas fisicamente no arquivo appserver.ini da pasta de instalação "[...]\BIN\APP"

Nota

title	Importante

Na seção HTTPURI, a chave PrepareIn deve ser comentada.

Segue exemplo de configuração do WS REST para utilização no modulo GTP:

Bloco de código

language	actionscript3
theme	Eclipse
title	appserver.ini

[HTTPV11]
SOCKETS=HTTPREST
ENABLE=1

[HTTPREST]
Port=8080
URIs=HTTPURI
Security=1

[HTTPURI]
URL=/rest
;PrepareIn=
Instances=1,2
CORSEnable=1
AllowOrigin=*

[HTTPJOB]
MAIN=HTTP_START
ENVIRONMENT=P12

[TAF_CFGJOB]
Main=TAF_CFGJOB
Instances=1,2,1,1
PrepareIn=T1 
RefreshRate=50
ENVIRONMENT=P12

[OnStart]
JOBS=HTTPJOB
RefreshRate=120

Informações

title	PrepareIn

A chave PrepareIn deve conter o código do Grupo de Empresas(sigamat.emp/syscompany) utilizado no modulo GTP, abaixo exemplos configurações possíveis para as mesmas:

Utilizando o código do grupo; Ex: PrepareIn=01
Utilizando diversos códigos de grupos; Ex: PrepareIn=01,02,99 .
Utilizando a palavra ALL, neste caso o server vai considerar todos os grupos contidos no arquivo de empresas do Protheus; Ex PrepareIn=ALL

Aviso

title	Consumo de Memória e CPU

O servidor cria Threads especificas para cada grupo de empresas de acordo com a configuração da chave Instances, por isso essa configuração deve ser realizada considerando a capacidade computacional do servidor.

Fonte: REST com ERP Microsiga Protheus

Definição dos métodos

POST

Descrição do Método: O método POST segue o conceito do próprio método em qualquer outro tipo de serviço REST, devendo seu conteúdo ser enviado no corpo da mensagem (body) no formato json.

O objetivo do método é enviar informações que devem ser gravadas nas tabelas do GTP, permitindo que os dados sejam submetidos aos processos de integração da filipetas

Estrutura da mensagem enviada no POST (Request):

Atributo	Pai	Nivel	Ocorrência	Formato	Cadastros Protheus
layoutColetor	-	1	1	-
softwareColetor	layoutColetor	1	1:1	String(

36

30)
versaoColetor	layoutColetor	1	1:1	String(

36

30)
cabecalho	-	1	1	-
empresa	cabecalho	1	1:1	String(6)	De/Para de empresas no configurador (SIGACFG) ( Ambiente - Schedule - De/Para de Mensagem Única)
matMotorista	cabecalho	1	0:1	String(15)

messageSequential

lote

2

	Matricula no cadastro de colaboradores
cartaoMotorista	cabecalho	1	0:1	String(50)
matCobrador	cabecalho	1	0:1	String(

03

15)

registryType

lote

2

Matricula no cadastro de colaboradores
cartaoCobrador	cabecalho	1	0:1	String(

10

50)

registryKey

lote

2


dataMovimento	cabecalho	1	1:1	String - AAAAMMDD
filipeta	cabecalho	1	1:1	String(

100

30)

integrationMessage

servicos

lote

-

2

0:1

Memo - Base64

Array

integrationDate

codServico

lote

servicos

2

0:1

String

- AAAAMM01

(15)
codVeiculo	servicos

integrationTime

lote

2

0:1

String

- HH:MM:SS

(8)	Prefixo no cadastro de frotas
prefixoLinha	servicos	2	0:1	String(5)	Prefixo no cadastro de linhas
codigoLinha	servicos

registryPrioritylote

2

0:1

String(

01)

5)	Código no cadastro de linhas
turno	servicos

integrationQueuelote

2

0:1

String(

01)erpowner

1)
dataInicioViagem	servicos	2	1:1	String - AAAAMMDD
dataTerminoViagem	servicos	2	1:1	String - AAAAMMDD
hrInicio	servicos

lote

2

0

1:1

String(

40

5)

registryPredecessor

hrFim

lote

servicos

2

0

1:1

String(

100)transferBranch

5)
dadosValidador	servicos	2	1	-
roletaInicioValidador	dadosValidador

lote

2

0:1

String(

40

10)

complement

roletaFim

lote

dadosValidador

2

0:1

String(

100

10)

layoutColetor – atributo raiz

pagamentos

cabecalho - atributo raiz

-	3	1	Array
tipoPagamento	pagamentos	3	1:1	String(6)	Tipo de pagamento no cadastro de Forma de pagamento
quantidadePassageiros	pagamentos	3	1:1	Numerico
valorUnitario	pagamentos	3	1:1	Numerico
totalArrecadado	servicos	2	0:1	Numerico
totalGratuidades	servicos	2	0:1	Numerico
totalDinheiro	servicos	2	0:1	Numerico
diferenca	servicos	2	0:1	Numerico

servicos - atributo raiz

Aviso

title	Atenção!

Os atributos não obrigatórios têm que fazer parte da estrutura, somente o seu preenchimento é opcional.

Bloco de código

language	js
theme	Eclipse
title	Exemplo de mensagem POST:

{
    "layoutColetor":{        
		"softwareColetor": "Software coletor",   
		"versaoColetor": "20"
	},
    "cabecalho":{
			  "empresa": "02",        
        "matMotorista": "000063",
			  "cartaoMotorista":"7475975", 
        "matCobrador": "919191",
			  "cartaoCobrador":"7475976",  
		    "dataMovimento": "20240101",
			  "filipeta":"000002582789610"
    },
    "servicos":[
        {
            "codServico": "02",
            "codVeiculo": "PREFIX",
            "prefixoLinha": "73859",
            "codigoLinha": "20",
            "turno": "1",
            "dataInicioViagem": "20240101",
            "dataTerminoViagem": "20240101",
            "hrInicio": "0200",
            "hrFim": "0300",            
            "dadosValidador":{    
                    "roletaInicioValidador": "0000001",
                    "roletaFim": "0000002",
                    "pagamentos":[{
                        "tipoPagamento": "000004",  
                        "quantidadePassageiros": 20,
                        "valorUnitario": 20.02                        
                    }]
                },
                "totalArrecadado": 200.00,
                "totalGratuidades": 12.30,
                "totalDinheiro": 32.50,  
                "diferenca": 10.10      
            }        
    ]
}

Estrutura da mensagem de retorno do POST (Response):

Atributo	Pai	Nivel	Ocorrência	Formato
status	-	1	0:1	String(7)
prestacaoContas	-	1	0:1	String(

36

6)
message	-	1	0:1	String(36)

status – Informação de sucesso ou erro
prestacaoContas – Código cadastrado da prestação de contas
Message - Mensagem de sucesso ou de erro

Bloco de código

language	js
theme	Eclipse
title	Response:

{
"ticketCodestatus": "WIO9753123654789789363655241452363sucess",
"registryKey": [
	{
		"key"prestacaoContas": "KEYIO7878874854545454998598525000002",
		"successstatus": true
	},
	{
		"key": "KEYYZE7878RE4854545454998598576",
		"success": true
	}
  ],
"keyAmount": 2
}

Códigos De Erros

"Prestação de contas incluída com sucesso",
}

Código De Erro De Validação:

800 400 – Campo não informado na estrutura do arquivo.
801 – Campo obrigatório não enviado.
Cadastro não encontrado

Legenda:

# - valor variável.

Bloco de código

language	js
title	Exemplo de mensagem POST:Exemplo de Resposta do método POST com erro de validação no LOTE.

{
    "coderr	"errorCode": 803400,
    "description	"errorMessage": "OCadastro valor do campo sourceBranch (TAFFIL) de linha não está no cadastro no complemento de empresas.encontrada"
}

RESTFAULT*

500 - Erro Interno no Servidor

Bloco de código

language	js
title	Exemplo de mensagem POST:Exemplo de Resposta do método POST com erro de validação no ITEM:.

{
  	"ticketCodecode": "WIO9753123654789789363655241452363"500,
  "registryKey": [
    {
      "key	"detailedMessage": "KEYIO7878874854545454998598525",
      "success": false,
      "error": [
        {
          "coderr": 801,
          "description": "Campo TAFFIL (sourceBranch)  e Obrigatorio."
        },
        {
          "coderr": 803,
          "description": "O valor do campo TAFFIL (sourceBranch)  nao esta cadastro no complemento de empresas."
        }
       {
          "coderr": 805,
          "description": "Codigo de Prioridade invalido! Codigo enviado: '8'. Codigos validos: 0 - Urgente, 1 - Prioridade Critica, 2 - Prioridade Alta, 3 - Prioridade Media, 4 - Prioridade Baixa, 5 - Nao Prioritario"
        }
      ]
    },
    {
      "key": "KEYYZE7878RE4854545454998598576",
      "success": true
    },
    {
      "key": "KEYQWE7878RE4854545454998598571",
      "success": true
    },
    {
      "key": "KEYQIU7878RE4854545454998598544",
      "success": true
    }
  ],
  "keyAmount": 4
}

RESTFAULT*

500 - Erro Interno no Servidor

	"message": "Internal Server Error"
}

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

Definição do Serviço

Configurações do Serviço

Definição dos métodos

POST

Estrutura da mensagem enviada no POST (Request):

Estrutura da mensagem de retorno do POST (Response):

Código De Erro De Validação:

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

Definição do Serviço

Configurações do Serviço

Definição dos métodos

POST

Estrutura da mensagem enviada no POST (Request):

Estrutura da mensagem de retorno do POST (Response):

Código De Erro De Validação: