Histórico da Página
Introdução
draw.io Diagram border false viewerToolbar true fitWindow false diagramDisplayName lbox false revision 2 diagramName TPR Geolocalização simpleViewer true width links auto tbstyle top diagramWidth 480
| border | false |
|---|---|
| viewerToolbar | true |
| fitWindow | false |
| diagramDisplayName | |
| lbox | false |
| revision | 2 |
| diagramName | TPR Geolocalização |
| simpleViewer | true |
| width | |
| links | auto |
| tbstyle | top |
| diagramWidth | 480 |
Sistemas Envolvidos
- VRPTW
- Sistema Externo: Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico da TOTVS.
Integração
- Formato de entrada/saída: JSON
Escopo
Pré-requisitos instalação/implantação/utilização
Instalação/Atualizaçã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
| TPRGeolocation: Integração rest, Assincrona: TPRGeolocationCB | ||||||
| Path: .../v1/trp-geolocationMétodo: POST | ||||||
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| DateCalldateCall | Date Time | Sim | Data da criação da chamada no sistema externo | Formato ISO8601 | 2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD | |
| Systemsystem | String | Não | 4096 | Identificador do sistema que fez a chamada | Texto Livre | Protheus |
| Versionversion | String | Não | 4096 | Versão do sistema externo | Texto Livre | 12.36.1 |
| Qualifiersqualifiers | Object | Não | 4096 | String chave valor | Formato Json | {"Usuario": "Pedro de alcantra", "Perfil": "Analista"} |
| CallbackURLcallbackURL | String | Sim | 4096 | URL de Call Back | Inicio com "https://" | |
| CallbackAuthenticationTypecallbackAuthenticationType | String | Sim | 4096 | Tipos de autenticação: Basic, None | Texto Livre | |
| CallbackAuthenticationValuecallbackAuthenticationValue | String | Sim | 4096 | Texto de acordo com formato indicado | Texto Livre | QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
| Lista de Address | TPRAddress | Sim | Lista de endereços a serem geolocalizados | - | ||
| TPRAddress, tipo de dado utilizado nas integrações do TPR | ||||||
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| Identifier | String | Sim | 4096 | Identificador unico do endereço | Texto livre | CLI-4693 |
| Country | String | Sim | 3 | Pais do endereço | Fomato ISO | "BRA" |
| State | String | Não | 2 | Estado do endereço | Quando Brasil valida as 27 opções, se informado | SP |
| City | String | Não | 4096 | Cidade do endereço | Texto livre | Bauru |
| ZipCode | String | Não | 4096 | Cep do endereço | Valida formato, se informado e se BRA | 17047-001 |
| Address | String | Sim | 4096 | Rua, número, Bairro e complemento do endereço | Texto livre | Gomes de carvalho, 940 |
Layout de Resposta
| TPRGeolocationResponse: 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 | - | 2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD | |
| Version | String | Sim | 4096 | Versão do TPR que excutou a resposta | - | 0.0.0.1 |
| Success | Boolean | Sim | True se sucesso, false se falha ?????? | - | True | |
| Message | TPRMessage List | Sim | Campo que deve ser exibido pelo sistema externo para o usuario | - | ||
Layout do Call Back
| TPRGeolocationCB: Integração rest, Assincrona | ||||||
Path: ver campo TPRGeolocation/CallbackURL, 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 | |
| Version | String | Não | 4096 | Versão do sistema externo | Texto Livre | 12.36.1 |
| GeolocationResult | TPRGeolocationResult | Sim | Lista de resultados de geolocalização | |||
| - |
| Tabela abaixo |
| TPRMessage: Tipo de dado utilizado nas integrações do TPR | ||||||
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| MessageCode | String | Sim | 4096 | Código de identificação da mensagem | Código existente e valido | TPR0001 |
| Message | String | Sim | 4096 | Mensagem escrita | Texto Livre | "Para finalizar o cadastro acesse seu e-mail e valide o Token" |
Catálogo de Erros
Código | Mensagem | Descrição |
|---|---|---|
| TPRGL001 |
| Informações | ||
|---|---|---|
| ||
| Não esperamos corpo na resposta para os call backs, este, será avaliado apenas o HTTP status para determinar o sucesso do envio. |
Anexos
| Anexos |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas