draw.io Diagram | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
TOTVS Planejamento de Rotas
Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico TOTVS.
Âncora | ||||
---|---|---|---|---|
|
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 | {"Usuário": "Pedro de Alcântara", "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 | Sim | Lista de endereços a serem geolocalizados | - |
Âncora | ||||
---|---|---|---|---|
|
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 |
TPRGeolocationResponse: Integração rest, sincrona | ||||||
---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
dateCall | 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[] | Sim | Campo que deve ser exibido pelo sistema externo para o usuario | - |
Layout do Call Back Âncora TPRGeolocationCB TPRGeolocationCB
TPRGeolocationCallback: 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 |
Âncora | ||||
---|---|---|---|---|
|
TPRGeolocationResult, tipo de dado utilizado nas integrações do TPR | ||||||
---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
sucess | Boolean | Sim | True se sucesso, false se falha | - | True | |
identifier | String | Sim | 4096 | Identificador unico do endereço | Texto livre | CLI-4693 |
latitude | Double | Não | Latitude | Intervalo [-90; 90] | -23.6114291 | |
longitude | Double | Não | Longitude | Intervalo [-180; 180] | -46.6946795 | |
message | TPRMessage[] | Sim | Campo que deve ser exibido pelo sistema externo para o usuario | - | Tabela abaixo |
Âncora | ||||
---|---|---|---|---|
|
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" |
Informações | ||
---|---|---|
| ||
Não esperamos corpo na resposta para os call backs, este, será avaliado apenas pelo HTTP status e este deve determinar o sucesso do envio. |
Âncora | ||||
---|---|---|---|---|
|
Código | Mensagem | Descrição |
---|---|---|
TPRGL001TPRGL0001 |
Anexos |
---|