Totvs Planejamento de Rotas

Árvore de páginas

Versões comparadas

Versão antiga 19

changes.mady.by.user Usuário desconhecido (willian.godoy)

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
bordertrue
viewerToolbartrue
fitWindowfalse
diagramNameTPR_visualizacao_rota
simpleViewerfalse
width
diagramWidth342
revision1

Sistemas Envolvidos

  • API JavaScript

  • TPR: TOTVS Planejamento de Rotas

Integração

  • Formato de entrada/saída: JSON

Escopo

  • Dados ao menos dois pontos, e um token de acesso válido, esta integração retornara uma lista de pernas, ou seja, a sequencia de pontos que representa a rota a ser executada entre estes pontos;

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

TPRRouteView: Integração rest, sincrona

Path: .../v1/tpr-

system

routes-

usage 

integration 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 Livre
versionStringNão4096Versão do sistema externoTexto Livre
qualifiersObjectNão4096String chave valorFormato Json
pointsTPRPoint[]Sim

Ao mínimo 2 pontos

Layout de Resposta

TPRRouteViewResponse, tipo de dado utilizado nas integrações do TPR
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
totalDistancedoubleSim
Distância total do plano de viagensrotas, em kmMaior ou igual a zero
legsTPRLegs[]

Rota e distância entre dois pontos-
messageTPRMessage[]Não
Campo que deve ser exibido pelo sistema externo para o usuário-Tabela abaixo

Âncora
TPRLeg
TPRLeg

TPRLeg, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
distancedoubleSim
Distância percorrida entre as paradasMaior ou igual a zero, referente ao tipo de rota.122.56
pointsTPRPoint[]Sim
Pontos de rota desta pernaCaso não seja encontrada rota válida, o retorno contemplará apenas o ponto
de partida desta perna, exceto pela última leg, que contempla o ponto de chegada
também.
routeTypeStringSim
Tipo da rota realizada nesta perna.Valores possíveis: "ROAD", "GEODESIC"ROAD

Âncora
TPRPoint
TPRPoint

TPRPoint, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
latitudedoubleSim
Latitude do ponto geográficoEntre -90 e 90 inclusive;-23.45
longitudedoubleSim
Latitude do ponto geográficoEntre -180 e 180 inclusive;-46.32

Â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"E-mail Invalido"

Catálogo de Mensagens

Âncora
TPRCatMsg
TPRCatMsg

Código

Mensagem

Descrição

TPRVR0000Sucesso.Retorno indicando sucesso da operação
TPRVR0001Data da criação A data da chamada no sistema externo é obrigatória.Retorno indicando que o dateCall enviado é vazio ou nuloinválido para a validação do campo dateCall, já que se encontra nulo ou vazio
TPRVR0002O valor do sistema possui mais de 4096 caracteres.Retorno indicando que a String de system tem tamanho acima do limiteinválido para a validação do campo system, porque é maior que 4096 caracteres
TPRVR0003A O valor da versão possui mais de 4096 caracteres.Retorno indicando que a String de version tem tamanho acima do limiteinválido para a validação do campo version, porque é maior que 4096 caracteres
TPRVR0004O valor do dos qualificadores possui mais de 4096 caracteres.Retorno indicando que a String de qualifiers tem tamanho acima do limiteinválido para a validação do campo qualifiers, porque é maior que 4096 caracteres
TPRVR0005Qualificadores Os qualificadores não estão em um formato válido (JSON válido.)Retorno inválido para a validação do campo qualifiers, já que está diferente do formato esperado de um objeto JSON em textoRetorno indicando falha ao tentar validar formato JSON do qualifiers fornecido
TPRVR0006São obrigatórios ao menos dois pontos geográficos.Retorno indicando que tem que haver pelo inválido para a validação do campo points, porque não tem ao menos dois pontos para gerar uma roda
TPRVR0007%s [VALOR_LATITUDE] não é uma latitude válida [-90.0, 90.0].Retorno indicando que  a latitude está fora do limiteinválido para a validação do campo latitude do objeto points, pois se encontra fora do intervalo válido -90 e 90 inclusive
TPRVR0008[VALOR_LONGITUDE] TPRVR0008%s não é uma longitude válida [-180.0, 180.0].Retorno indicando que  a longitude está fora do limiteinválido para a validação do campo longitude do objeto points, pois se encontra fora do intervalo válido -180 e 180 inclusive
TPRVR0009Erro interno, tente novamente e se o problema persistir contate: [EMAIL_SUPORTE]TPRVR0009Chamada remota falhou: %s.Retorno indicando que a comunicação com o projeto tpr-routes para geração da rota falhou
TPRVR0010A mensagem está mal formatadaRetorno 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"Formato inválido.Retornando indicando que há erro em algum formato do JSONTPRVR0011JSON inválido.Retorno indicando que há algum problema no JSON

Anexos

Anexos