IMPORTANTE
- A integração TOTVS OMS x TOTVS Planejamento de Rotas (TPR) será descontinuada no próximo release (Outubro/2023).
Introdução
Sistemas Envolvidos
- API JavaScript
TPR: TOTVS Planejamento de Rotas
Integração
- Formato de entrada/saída: JSON
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-routes-integration 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 | |
| version | String | Não | 4096 | Versão do sistema externo | Texto Livre | |
| qualifiers | Object | Não | 4096 | String chave valor | Formato Json | |
| points | TPRPoint[] | Sim | Ao mínimo 2 pontos | |||
Layout de Resposta
| TPRRouteViewResponse, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| 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 | |
| totalDistance | double | Sim | Distância total do plano de rotas, em km | Maior ou igual a zero | ||
| legs | TPRLegs[] | Rota e distância entre dois pontos | - | |||
| message | TPRMessage[] | Não | Campo que deve ser exibido pelo sistema externo para o usuário | - | Tabela abaixo | |
| TPRLeg, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| distance | double | Sim | Distância percorrida entre as paradas | Maior ou igual a zero, referente ao tipo de rota. | 122.56 | |
| points | TPRPoint[] | Sim | Pontos de rota desta perna | Caso 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. | ||
| routeType | String | Sim | Tipo da rota realizada nesta perna. | Valores possíveis: "ROAD", "GEODESIC" | ROAD | |
| TPRPoint, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| latitude | double | Sim | Latitude do ponto geográfico | Entre -90 e 90 inclusive; | -23.45 | |
| longitude | double | Sim | Latitude do ponto geográfico | Entre -180 e 180 inclusive; | -46.32 | |
| 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 | "E-mail Invalido" |
Catálogo de Mensagens
Código | Mensagem | Descrição |
|---|---|---|
| TPRVR0000 | Sucesso | Retorno indicando sucesso da operação |
| TPRVR0001 | A data da chamada é obrigatória | Retorno inválido para a validação do campo dateCall, já que se encontra nulo ou vazio |
| TPRVR0002 | O valor do sistema possui mais de 4096 caracteres | Retorno inválido para a validação do campo system, porque é maior que 4096 caracteres |
| TPRVR0003 | 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 |
| TPRVR0004 | O valor dos qualificadores possui mais de 4096 caracteres | Retorno inválido para a validação do campo qualifiers, porque é maior que 4096 caracteres |
| TPRVR0005 | 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 |
| TPRVR0006 | São obrigatórios ao menos dois pontos geográficos | Retorno inválido para a validação do campo points, porque não tem ao menos dois pontos para gerar uma roda |
| TPRVR0007 | [VALOR_LATITUDE] não é uma latitude válida [-90.0, 90.0] | Retorno invá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] não é uma longitude válida [-180.0, 180.0] | Retorno inválido para a validação do campo longitude do objeto points, pois se encontra fora do intervalo válido -180 e 180 inclusive |
| TPRVR0009 | Erro interno, tente novamente e se o problema persistir contate: [EMAIL_SUPORTE]. | Retorno indicando que a comunicação com o projeto tpr-routes para geração da rota falhou |
| TPRVR0010 | 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" |
Anexos
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas