Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Introdução

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxtrue
revision3
diagramNameTPR Geolocalização
simpleViewerfalse
width300
linksauto
tbstylehidden
diagramWidth480


Sistemas Envolvidos

  • VRPTW
  • Sistema Externo: Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico da TOTVS.

Integração

  • Formato de entrada/saída: JSON

Escopo


Pré-requisitos instalação/implantação/utilização

  • Para clientes Protheus versão xxxxxx;
  • Para clientes Datasul versão xxxxxx;
  • Para clientes externos contratação do trial via TOTVS Store;

Layout de Requisição

TPRGeolocation: Integração rest, Assincrona com a TPRGeolocationCB
Path: .../v1/trp-geolocation Método: POST
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
dateCallDate TimeSim
Data da criação da chamada no sistema externoFormato ISO86012021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
systemStringNão4096Identificador do sistema que fez a chamadaTexto LivreProtheus
versionStringNão4096Versão do sistema externoTexto Livre12.36.1
qualifiersObjectNão4096String chave valorFormato Json{"Usuario": "Pedro de alcantra", "Perfil": "Analista"}
callbackURLStringSim4096URL de Call BackInicio com "https://"
callbackAuthenticationTypeStringSim4096Tipos de autenticação: Basic, NoneTexto Livre
callbackAuthenticationValueStringNão4096Texto de acordo com formato indicadoTexto LivreQWxhZGRpbjpvcGVuIHNlc2FtZQ==
addressSim
Lista de endereços a serem geolocalizados-

Âncora
TPRAddress
TPRAddress

TPRAddress, tipo de dado utilizado nas integrações do TPR

CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
identifierStringSim4096Identificador unico do endereçoTexto livreCLI-4693
countryStringSim3Pais do endereçoFomato ISO"BRA"
stateStringNão2Estado do endereçoQuando Brasil valida as 27 opções, se informadoSP
cityStringNão4096Cidade do endereçoTexto livreBauru
zipCodeStringNão4096Cep do endereçoValida formato, se informado e se BRA17047-001
addressStringSim4096Rua, número, Bairro e complemento do endereçoTexto livreGomes de carvalho, 940

Layout de Resposta

TPRGeolocationResponse: Integração rest, sincrona
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
dateResponseDate TimeSim
Data do envio da resposta no TPR-2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
versionStringSim4096Versão do TPR que excutou a resposta-0.0.0.1
successBooleanSim
True se sucesso, false se falha ??????-True
messageTPRMessage ListSim
Campo que deve ser exibido pelo sistema externo para o usuario-

Âncora
TPRMessage
TPRMessage

TPRMessage: Tipo de dado utilizado nas integrações do TPR

CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
messageCodeStringSim4096Código de identificação da mensagemCódigo existente e validoTPR0001
messageStringSim4096Mensagem escritaTexto Livre"Para finalizar o cadastro acesse seu e-mail e valide o Token"

Layout do Call Back

TPRGeolocationCB: Integração rest, Assincrona

Path: ver campo TPRGeolocation/CallbackURL, Método: POST

CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
dateCallDate TimeSim
Data da criação da chamada no sistema externoFormato ISO2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
versionStringNão4096Versão do sistema externoTexto Livre12.36.1
geolocationResultTPRGeolocationResultSim
Lista de resultados de geolocalização-Tabela abaixo
Informações
titleRetorno do Call Back
Não esperamos corpo na resposta para os call backs, este, será avaliado apenas pelo HTTP status para determinar o sucesso do envio.

Catálogo de Erros

Código

Mensagem

Descrição

TPRGL001

Anexos

Anexos