Integração de Pesagem - ATF

Descrição

A rotina a seguir visa disponibilizar uma integração de pesagens com o Agrotitan Fazendas.

Índice

1 Descrição
2 Índice
3 Pré-requisitos
4 Recepção das pesagens
- 4.1 Rota
- 4.2 Cabeçalhos
- 4.3 Corpo (body)
- 4.4 Detalhamento dos campos no corpo da requisição
5 Retornos
6 Erros Comuns
7 Versão

Para caminhos, será considerado C:\VIASOFT\AgrotitanFazendas para o sistema para melhor exemplificação.

Abreviações podem aparecer como .\Data, que significa C:\VIASOFT\AgrotitanFazendas\Data

Pré-requisitos

Configuração do Serviço .\WebServerPSGA_Balanca\back-end-psga-balanca.

Recepção das pesagens

Deve ser enviado um POST para o endereço configurado em P_INTEGRACAO_PESAGEM_ARMAZEM_HOST (o cliente irá fornecer essa informação).

Rota

{url}/romaneio

Cabeçalhos

Nenhum

Corpo (body)

{
	"usuario_armazem": "INTEGRACAO_X",
	"data_entrada": "dd-MM-yyyy",
	"hora_entrada": "hh:mm",
	"peso_entrada": "0",
	"data_saida": "dd-MM-yyyy",
	"hora_saida": "hh:mm",
	"peso_saida": "0",
	"cod_ticket": "",
	"cpf_motorista": "",
	"nome_motorista": "",
	"placa": "",
	"placa_uf": "",
	"descricao_veiculo": "",
	"fluxo": "",
	"foto1A": "dd/MM/yyyy hh:mm:ss_A",
	"foto1B": "dd/MM/yyyy hh:mm:ss_B",
	"foto2A": "dd/MM/yyyy hh:mm:ss_A",
	"foto2B": "dd/MM/yyyy hh:mm:ss_B"
}

Detalhamento dos campos no corpo da requisição

Campo	Tipo	Tamanho	Descrição	Obrig.

Campo	Tipo	Tamanho	Descrição	Obrig.
`usuario_armazem`	char	20	Usuário que deve ser cadastrado no Agrotitan Fazendas com prefixo “INTEGRACAO”. Para identificação das requisições	Sim
`data_entrada`	date	-	Data da pesagem de entrada no formato `dd/MM/yyyy`	¹
`hora_entrada`	char	5	Hora da pesagem de entrada no formato `hh:mm`	¹
`peso_entrada`	num	14,8	Peso da entrada	¹
`data_saida`	date	-	Data da pesagem de saída no formato `dd/MM/yyyy`	²
`hora_saida`	char	5	Hora da pesagem de saída no formato `hh:mm`	²
`peso_saida`	num	14,8	Peso da saída	²
`cod_ticket`	char	15	Código de controle do sistema de terceiros. Deve ser um código único. Esse código será utilizado pelos tickets no campo `COD_INTEGRACAO_PESAGEM`	Sim
`cpf_motorista`	char	11	Número do CPF do motorista com ou sem pontuações	Sim
`nome_motorista`	char	50	Nome do motorista	Sim
`placa`	char	7	Placa do veículo com ou sem pontuações	Sim
`placa_uf`	char	2	UF da placa do veículo, pois não é possível extrair de placas Mercosul. Deve obrigatoriamente ser um dos seguintes valores: `'AC','AL','AM','AP','BA','CE','DF','ES','GO','MA','MG','MS','MT', 'PA','PB','PE','PI','PR','RJ','RN','RO','RR','RS','SC','SE','SP','TO'`	Sim
`descricao_veiculo`	char	40	Breve descrição do veículo	Sim
`fluxo`	varchar	-	Código do acesso, fluxo ou processo da rotina de pesagem da aplicação de terceiros. Deve ser cadastrado/informado no arquivo `.\WebServerPSGA_Balanca\back-end-psga-balanca\config\fluxos`, também informando o tipo do romaneio e se é necessário gerar o romaneio. Esse código serve apenas para identificar o fluxo da pesagem e se gera romaneio ou não.	Sim
³ `foto1A`	char	25	Fotos torre 1A	Não
³ `foto1B`	char	25	Fotos torre 1B	Não
³ `foto2A`	char	25	Fotos torre 2A	Não
³ `foto2B`	char	25	Fotos torre 2B	Não

¹ obrigatório apenas para fluxos de entrada

² obrigatório apenas para fluxos de saída

³ campos de fotos devem ser enviados apenas o nome da foto com extensão

Retornos

Sucesso

Retornará 200 para requisições processadas com sucesso com as seguintes informações:

{
  "executouServico": true,
  "dtHoraRetorno": "yyyy-MM-dd",
  "mensagemFalha": "",
  "mensagemSucesso": "Dados recebidos com sucesso!"
}

Falha

Retornará 500 para requisições que não foram processadas ou que enviaram dados inconsistentes com as seguintes informações:

{
  "executouServico": false,
  "dtHoraRetorno": "yyyy-MM-dd",
  "mensagemFalha": "Campo [fluxo] obrigatório(a) não foi informado",
  "mensagemSucesso": ""
}

Erros Comuns

Situações que podem ocorrer durante o uso da rotina

Versão

Versão do Sistema	Versão do Banco de Dados	Versão da Documentação	Autor/Revisor

Versão do Sistema	Versão do Banco de Dados	Versão da Documentação	Autor/Revisor
4.10.18.32	4.10.18.32	2.0	Uanderson Leonel
4.10.16.87	4.10.16.87	1.0	Leonardo Dagios

Documentação para Usuários