Introdução

draw.io Diagram

Sistemas Envolvidos

Planejamento de rotas
Sistema Externo: Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico da TOTVS.

"hand shake" entre o TPR eo sistema externo, resulta na criação de token de acesso para o cliente, que após validade via e-mail liberará o acesso ao sistema via trial.

TPRTokenCreation: Integração rest, sincrona Path: .../v1/tpr-token-creation, 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
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"}
identifierType	String	Sim		Tipos de identificadores possíveis	CNPJ \ CPF	"CNPJ"
identifier	String	Sim	4096	Identificador único do cliente, CNPJ ou CPF	CNPJ válido; CPF válido; Precisa ser único na base;	"53.113.791/0001-22"
name	String	Sim	4096	Nome de identificação do cliente	Texto Livre	"Neolog Consultoria e Sistemas S&A"
shortName	String	Não	4096	Como o cliente gostaria de ser chamado	Texto Livre	"Neolog"
email	String	Sim	4096	E-mail para validação do token e futuras interações com o cliente	E-mail válido [email protected]	"neolog@neolog.com.br"

TPRTokenResponse: 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	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
sucess	Boolean	Sim		True se sucesso, False se falha	-	True
key	String	Não	4096	Chave bloqueada	-
message	TPRMessage List	Sim		Campo que deve ser exibido pelo sistema externo para o usuário	-	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"

Código	Mensagem	Descrição
TPRTK0001	CPF ou CNPJ Inválido	Retorno inválido para a validação do campo identifier
TPRTK0002	E-mail Inválido	Retorno inválido para a validação do campo email

Anexos