Histórico da Página
Introdução
draw.io Diagram border true viewerToolbar true fitWindow false diagramDisplayName lbox true revision 3 diagramName TPR Geolocalização simpleViewer false width 200 links auto tbstyle top diagramWidth 480
| border | true |
|---|---|
| viewerToolbar | true |
| fitWindow | false |
| diagramDisplayName | |
| lbox | true |
| revision | 3 |
| diagramName | TPR Geolocalização |
| simpleViewer | false |
| width | 200 |
| 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
- 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 com a TPRGeolocationCB | ||||||
| Path: .../v1/trp-geolocation 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 ISO8601 | 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 | {"Usuario": "Pedro de alcantra", "Perfil": "Analista"} |
| callbackURL | String | Sim | 4096 | URL de Call Back | Inicio com "https://" | |
| callbackAuthenticationType | String | Sim | 4096 | Tipos de autenticação: Basic, None | Texto Livre | |
| callbackAuthenticationValue | String | Não | 4096 | Texto de acordo com formato indicado | Texto Livre | QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
| address | TPRAddress List | 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 | - | ||
| 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" |
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 | |
| Informações | ||
|---|---|---|
| ||
| Não esperamos corpo na resposta para os call backs, este, será avaliado apenas pelo HTTP status para determinar o sucesso do envio. |
Catálogo de Erros
Código | Mensagem | Descrição |
|---|---|---|
| TPRGL001 |
Anexos
| Anexos |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas