Histórico da Página
Introdução
| draw.io Diagram | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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 de entrada/saída: JSON
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: .../v1/tpr-system-usage Método: POST | ||||||
| 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 | Object | Não | 4096 | String chave valor | Formato Json | {"Usuário": "Pedro de Alcântara", "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 | |
| Âncora | ||||
|---|---|---|---|---|
|
| 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 viagens geradas | Maior ou igual a zero | 332 [Viagens] | |
| totalDistance | double | Sim | Distância total do plano de viagens, em km | Maior ou igual a zero | 3022 [km] | |
| totalStops | integer | Sim | Quantidade total de paradas do plano de viagens | Maior ou igual a zero | 239 [Paradas] | |
| totalVolume | double | Sim | Volume total em viagens, em m³ | Maior ou igual a zero | 50.000 [m³] | |
| totalWeight | double | Sim | Peso total em viagens, em kg | Maior ou igual a zero | 2.500.000 [kg] | |
| totalDuration | double | Sim | Duração total do plano de viagens, 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³] | |
| Âncora | ||||
|---|---|---|---|---|
|
| 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 | |
| Âncora | ||||
|---|---|---|---|---|
|
| 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 viagens cuja rota foi gerada | Maior que zero | ||
| totalLegs | integer | Sim | Quantidade total de pernas cuja rota foram geradas | Maior que zero | ||
| Âncora | ||||
|---|---|---|---|---|
|
| 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
Âncora TPRCatMsg TPRCatMsg
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álidainválida | ||||
| TPRUS0002 | Qualifiers Os qualificadores não estão em um formato válido (JSON válido | Retorno indicando falha ao tentar validar formato JSON do qualifiers fornecido | ) | 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 | TPRUS0003 | A versão %s possui mais de 4096 caracteres | Retorno indicando que a String de version está com tamanho acima do limite | TPRUS0004 | inválido para a validação do campo version, porque é maior que 4096 caracteres |
| TPRUS0004 | O valor dos qualificadores A chave %s do qualificador possui mais de 4096 caracteres | Retorno indicando que a String de qualifiers está com tamanho acima do limiteinválido para a validação do campo qualifiers, porque é maior que 4096 caracteres | ||||
| TPRUS0005 | O identificador valor do sistema externo %s possui mais de 4096 caracteres | Retorno indicando que a String de system está com tamanho acima do limite | ||||
| TPRUS0006 | Data da criação da chamada no sistema externo é obrigatória. | Retorno indicando que dateCall foi enviado vazio ou nulo | ||||
| 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 | Mensagem, TPRSystemUsage, mal formatada | Retorno indicando que a mensagem está diferente do contrato indicado acima, logo se encontra num formato inválido | TPRUS0007 | Formato inválido. | Retorno indicando erro qualquer problema no JSON |
| Anexos |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas