draw.io Diagram | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
TPRGeolocation: Integração rest, Assincrona | ||||||
Path: .../v1/trp-geolocationMé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 | 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 |
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 | - |
TPRGeolocationResult, tipo de dado utilizado nas integrações do TPR | ||||||
---|---|---|---|---|---|---|
Campo | Tipo | 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 List | Sim | Campo que deve ser exibido pelo sistema externo para o usuario | - | Para finalizar o cadastro acesse seu e-mail e valide o Token | |
Não esperamos copo na resposta para este call back; avaliado apenas o HTTP status para determinar se foi enviado com sucesso. |
Anexos |
---|