IMPORTANTE
- A integração TOTVS OMS x TOTVS Planejamento de Rotas (TPR) será descontinuada no próximo release (Outubro/2023).
Introdução
Sistemas Envolvidos
- 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 JSON, para maiores detalhes consulte os Exemplos.
Escopo
- Dado um período e um token de acesso válido, retornaremos via Json os usos no período das integrações de geolocalização, visualização de rotas e roteirização.
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 | ||||||
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| dateCall | Date Time | Sim | Data da criação da chamada no sistema externo | Formato ISO | 2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD | |
| system | String | Não | 4096 | Identificador do sistema que fez a chamada | Texto Livre | Protheus |
| version | String | Não | 4096 | Versão do sistema externo | Texto Livre | 12.36.1 |
| qualifiers | String | Não | 4096 | String 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"}) |
| timeWindowStart | Date Time | Não | Inicio da janela a ser consultada | Formato ISO8601 TimeWindowStart deve ser anterior a TimeWindowEnd, se ambos preenchidos Se vazio consideraremos o mês corrente; | "2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD" | |
| timeWindowEnd | Date Time | Não | Final da janela a ser consultada | Formato ISO8601 TimeWindowEnd deve ser posterior de TimeWindowStart, se ambos preenchidos Se vazio 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 | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| dateResponse | Date Time | Sim | Data do envio da resposta no TPR | Formato ISO | 2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD | |
| version | String | Sim | 4096 | Versão do TPR que executou a resposta | - | 0.0.0.1 |
| success | Boolean | Sim | True se sucesso, false se falha | - | True | |
| routedSummary | TPRRoutedSummary[] | Não | - | Tabela abaixo | ||
| geolocationSummary | TPRGeolocationSummary[] | Não | - | Tabela abaixo | ||
| routeViewSummary | TPRRouteViewSummary[] | Não | - | Tabela abaixo | ||
| message | TPRMessage[] | Não | Campo que deve ser exibido pelo sistema externo para o usuario | - | Tabela abaixo | |
| TPRRoutedSummary, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| submissonDateTime | Date Time | Sim | Instante em que a request foi aceita pelo TPR | Formato ISO8601 | 2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD | |
| totalTrips | integer | Sim | Quantidade total de rotas geradas | Maior ou igual a zero | 332 [Rotas] | |
| totalDistance | double | Sim | Distância total do plano de rotas, em km | Maior ou igual a zero | 3022 [km] | |
| totalStops | integer | Sim | Quantidade total de paradas do plano de rotas | Maior ou igual a zero | 239 [Paradas] | |
| totalVolume | double | Sim | Volume total em rotas, em m³ | Maior ou igual a zero | 50.000 [m³] | |
| totalWeight | double | Sim | Peso total em rotas, em kg | Maior ou igual a zero | 2.500.000 [kg] | |
| totalDuration | double | Sim | Duração total do plano de rotas, em milissegundos | Maior ou igual a zero | 57600000 [ms] | |
| rejectedOrders | integer | Sim | Quantidade de pedidos rejeitados | Maior ou igual a zero | 10 [Pedidos] | |
| rejectedWeight | double | Sim | Total de peso rejeitado, em kg | Maior ou igual a zero | 2.500.000 [kg] | |
| rejectedVolume | double | Sim | Total de volume rejeitado, em m³ | Maior ou igual a zero | 50.000 [m³] | |
| chargedRouterization | booleano | Sim | Indica se a roteirização foi cobrada | Verdadeiro ou Falso | Verdadeiro | |
| tollCalculated | booleano | Sim | Indica se foi realizado o cálculo do pedágio | Verdadeiro ou Falso | Verdadeiro | |
| TPRGeolocationSummary, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| submissionDate | Date | Sim | Data em que as requests foram aceitas pelo TPR. | Formato ISO8601 | 2021-01-21 | |
| totalGeolocation | integer | Sim | Total de localidades que foram geolocalizadas com sucesso. | Maior que zero | ||
| totalGeolocationFailures | integer | Sim | Total de localidades que não foram geolocalizadas nesta data. | Maior ou igual a zero | 0, 1500 | |
| numberOfRequests | integer | Sim | Total de requests recebidas e processadas nesta data. | Maior que zero | 1, 1500 | |
| numberOfCallbacks | integer | Sim | Total de callbacks de geolocalização realizadas nesta data. | Maior ou igual a zero | 0, 1500 | |
| totalFailureCallbacks | integer | Sim | Total de callbacks de geolocalização que falharam nesta data | Maior ou igual a zero | 0, 1500 | |
| TPRRouteViewSummary, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| submissionDate | Date | Sim | Data em que as requests foram aceitas pelo TPR. | Formato ISO8601 | 2021-01-21 YYYY-MM-DD | |
| totalRoutes | integer | Sim | Quantidade de rotas que foram geradas para o mapa | Maior que zero | ||
| totalLegs | integer | Sim | Quantidade total de pernas cuja rota foram geradas | Maior que zero | ||
| TPRMessage, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| messageCode | String | Sim | Código de identificação da mensagem | Código existente e valido | TPR0001 | |
| message | String | Sim | 4096 | Mensagem escrita | Texto Livre | "Email Invalído" |
Catálogo de Mensagens
Código | Mensagem | Descrição |
|---|---|---|
| TPRUS0000 | Sucesso. | Retorno indicando sucesso da operação |
| TPRUS0001 | A 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 |
| TPRUS0002 | Os 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 |
| TPRUS0003 | O valor da versão possui mais de 4096 caracteres. | Retorno inválido para a validação do campo version, porque é maior que 4096 caracteres |
| TPRUS0004 | O valor dos qualificadores possui mais de 4096 caracteres. | Retorno inválido para a validação do campo qualifiers, porque é maior que 4096 caracteres |
| TPRUS0005 | O valor do sistema possui mais de 4096 caracteres. | Retorno inválido para a validação do campo system, porque é maior que 4096 caracteres |
| TPRUS0006 | A data da chamada é obrigatória. | Retorno inválido para a validação do campo dateCall, já que se encontra nulo ou vazio |
| TPRUS0007 | A mensagem está mal formatada. | Retorno indicando que a mensagem está diferente do contrato indicado acima, logo se encontra num formato inválido |
| TPRTK0032 | A 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. |
| TPRTK0033 | A 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. |
| TPRTK0034 | A 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. |
| TPRTK0036 | O 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" |
| TPRTK0037 | O 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" |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas