Totvs Planejamento de Rotas

Árvore de páginas

Versões comparadas

Versão antiga 9

changes.mady.by.user Julio Vinicius Oliveira dos Santos

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Vanessa Aparecida Martins de Melo

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Aviso
titleIMPORTANTE
  • A integração TOTVS OMS x TOTVS Planejamento de Rotas (TPR) será descontinuada no próximo release (Outubro/2023).

Introdução

draw.io Diagram
border

true

false
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxtrue
revision1
diagramNameTPR_uso_sistema
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth348

revision1

Sistemas Envolvidos

API JavaScript

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

Integração

  • Formato de entrada/saída: JSONJSON, para maiores detalhes consulte os Exemplos.

Escopo

Escopo

  • Bla bla bla

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

TPRSystemUsage: Integração rest, sincrona

Path: https://planejamentorotasqa.totvs.

.

com/v1/tpr-system-usage Método: POST

Header obrigatório: Chave = "TPR_AUTHORIZATION" e Valor = Chave gerada na integração de Criação de token

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
systemStringNão4096Identificador do sistema que fez a chamadaTexto LivreProtheus
versionStringNão4096Versão do sistema externoTexto Livre12.36.1
qualifiers
Object
StringNão4096String
chave valorFormato Json
representando um objeto JSON que tenha o nome da variável e valor sendo String.Formato JSON

"{ \"Usuario\": \"Pedro\", \"Perfil\": \"Analista\" }"


OBS: É equivalente usar JSON.stringify({"Usuario":"Pedro", "Perfil":"Analista"})

timeWindowStartDate TimeNão
Inicio da janela a ser consultadaFormato ISO8601
TimeWindowStart deve ser anterior a TimeWindowEnd, se ambos preenchidos
Se vazio
consuderaremos
consideraremos o mês corrente;"2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD"
timeWindowEndDate TimeNão
Final da janela a ser consultadaFormato ISO8601
TimeWindowEnd deve ser posterior de TimeWindowStart, se ambos preenchidos
Se vazio
consuderaremos
consideraremos o mês corrente;"2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD"

Layout de Resposta

TPRSystemUsageResponse: Integração rest, sincrona
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
dateResponseDate TimeSim
Data do envio da resposta no TPRFormato ISO2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
versionStringSim4096Versão do TPR que executou a resposta-0.0.0.1
successBooleanSim
True se sucesso, false se falha-True
routedSummaryTPRRoutedSummary[]Não

-Tabela abaixo
geolocationSummaryTPRGeolocationSummary[]Não

-Tabela abaixo
routeViewSummaryTPRRouteViewSummary[]Não

-Tabela abaixo
messageTPRMessage[]Não
Campo que deve ser exibido pelo sistema externo para o usuario-Tabela abaixo

Âncora
TPRRoutedSummary
TPRRoutedSummary

TPRRoutedSummary, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
submissonDateTime
DateTime
Date TimeSim
Instante em que a request foi aceita pelo TPRFormato ISO86012021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
totalTripsintegerSim
Quantidade total de
viagens
rotas geradasMaior ou igual a zero332 [
Viagens
Rotas]
totalDistancedoubleSim
Distância total do plano de
viagens
rotas, em kmMaior ou igual a zero3022 [km]
totalStopsintegerSim
Quantidade total de paradas do plano de
viagens
rotasMaior ou igual a zero239 [Paradas]
totalVolumedoubleSim
Volume total em
viagens
rotas, em m³Maior ou igual a zero50.000 [m³]
totalWeightdoubleSim
Peso total em
viagens
rotas, em kgMaior ou igual a zero2.500.000 [kg]
totalDurationdoubleSim
Duração total do plano de
viagens
rotas, em milissegundosMaior ou igual a zero57600000 [ms]
rejectedOrdersintegerSim
Quantidade de pedidos rejeitadosMaior ou igual a zero10 [Pedidos]
rejectedWeightdoubleSim
Total de peso rejeitado, em kgMaior ou igual a zero2.500.000 [kg]
rejectedVolumedoubleSim
Total de volume rejeitado, em m³Maior ou igual a zero50.000 [m³]
chargedRouterizationbooleanoSim
Indica se a roteirização foi cobradaVerdadeiro ou FalsoVerdadeiro
tollCalculatedbooleanoSim
Indica se foi realizado o cálculo do pedágioVerdadeiro ou FalsoVerdadeiro

Âncora
TPRGeolocationSummary
TPRGeolocationSummary

TPRGeolocationSummary, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
submissionDateDateSim
Data em que as requests foram aceitas pelo TPR.Formato ISO8601

2021-01-

21T10:01:00.0-03:00

21
YYYY-MM-

DDThh:mm:ss.sTZD

DD

totalGeolocationintegerSim
Total de localidades que foram geolocalizadas com sucesso.Maior que zero
totalGeolocationFailuresintegerSim
Total de localidades que não foram geolocalizadas nesta data.Maior ou igual a zero0, 1500
numberOfRequestsintegerSim
Total de requests recebidas e processadas nesta data.Maior que zero1, 1500
numberOfCallback
numberOfCallbacksintegerSim
Total de callbacks de geolocalização realizadas nesta data.Maior ou igual a zero0, 1500
totalFailuresCallback
totalFailureCallbacksintegerSim
Total de callbacks de geolocalização que falharam nesta dataMaior ou igual a zero0, 1500

Âncora
TPRRouteViewSummary
TPRRouteViewSummary

TPRRouteViewSummary, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
submissionDateDateSim
Data em que as requests foram aceitas pelo TPR.Formato ISO86012021-01-
21T10:01:00.0-03:00
21
YYYY-MM-
DDThh:mm:ss.sTZD
DD
totalRoutesintegerSim
Quantidade de
viagens cuja rota foi gerada
rotas que foram geradas para o mapaMaior que zero
totalLegsintegerSim
Quantidade total de pernas cuja rota foram geradasMaior que zero

Âncora
TPRMessage
TPRMessage

TPRMessage, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
messageCodeStringSim
Código de identificação da mensagemCódigo existente e validoTPR0001
messageStringSim4096Mensagem escritaTexto Livre"Email Invalído"

Catálogo de Mensagens

Âncora
TPRCatMsg
TPRCatMsg

Código

Mensagem

Descrição

TPRUS0000Sucesso.Retorno indicando sucesso da operação
TPRUS0001A janela de tempo inicia após a data indicada como fim.Retorno inválido indicando que o campo timeWindowStart está com um valor maior que o campo timeWindowEnd, com isso formando uma janela de tempo inválida 
TPRUS0002Os qualificadores não estão em um formato válido (JSON)Retorno inválido para a validação do campo qualifiers, já que está diferente do formato esperado de um objeto JSON em texto
TPRUS0003O valor da versão possui mais de 4096 caracteres.Retorno inválido para a validação do campo version, porque é maior que 4096 caracteres
TPRUS0004O valor dos qualificadores possui mais de 4096 caracteres.Retorno inválido para a validação do campo qualifiers, porque é maior que 4096 caracteres
TPRUS0005O valor do sistema possui mais de 4096 caracteres.Retorno inválido para a validação do campo system, porque é maior que 4096 caracteres
TPRUS0006A data da chamada é obrigatória.Retorno inválido para a validação do campo dateCall, já que se encontra nulo ou vazio
TPRUS0007A mensagem está mal formatada.Retorno indicando que a mensagem está diferente do contrato indicado acima, logo se encontra num formato inválido
TPRTK0032A chave do token não foi informada.Retorno inválido para requisição que não envia o header "TPR_AUTHORIZATION" com a chave do token.
TPRTK0033A chave do token informada não foi encontrada.Retorno inválido para requisição que enviar uma chave no header "TPR_AUTHORIZATION" que não existe na base de dados.
TPRTK0034A vigência do seu plano chegou ao fim. Para reativar refaça o cadastro.Retorno inválido para requisição que enviar uma chave no header "TPR_AUTHORIZATION" que não tenha um plano vigente.
TPRTK0036O seu período de pré-trial acabou! Você ainda pode experimentar o TOTVS PLANEJAMENTO DE ROTAS por 30 dias, gratuitamente, assinando o Trial através da TOTVS Store [Link TOTVS Store].Retorno inválido para requisição que enviar uma chave no header "TPR_AUTHORIZATION" que já tenha consumido toda quota de roteirizações ou finalizado o tempo de "TRIAL"
TPRTK0037O seu trial chegou ao fim. Para continuar usando o Totvs Planejamento de Rotas, faça a contratação acessando "https://partner.totvs.store/br/produto/totvs-planejamento-de-rotas.html".Retorno inválido para requisição que enviar uma chave no header "TPR_AUTHORIZATION" que já tenha finalizado o tempo de "TRIAL"

Anexos