Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Introdução

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxtrue
revision1
diagramNameCriação de token
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth348

Sistemas Envolvidos

  • TPR:

    • TOTVS Planejamento de Rotas
  • Sistema Externo:

    • Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico TOTVS.

Integração

  • Formato de entrada/saída: JSON

Escopo

  • "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 de acordo com o fluxo:

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxfalse
revision1
diagramNameCriação de token - Macro fluxo
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth656

revision1

Pré-requisitos instalação/implantação/utilização

  • Para clientes Protheus versão xxxxxx;
  • Para clientes Datasul versão xxxxxx;
  • Para todos os clientes, contratação do trial via TOTVS Store;

Layout de Requisição

TPRTokenIntegration: Integração rest, sincrona

Path: .../v1/tpr-token-creation, Método: POST

CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
dateCallDate TimeSim
Data da criação da chamada no sistema externoFormato ISO2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
systemStringNão4096Identificador do sistema que fez a chamadaTexto LivreProtheus
versionStringNão4096Versão do sistema externoTexto Livre12.36.1
qualifiersObjectNão4096String chave valorFormato Json{"Usuário": "Pedro de Alcântara", "Perfil": "Analista"}
identifierTypeStringSim
Tipos de identificadores possíveisCNPJ \ CPF"CNPJ"
identifierStringSim4096Identificador único do cliente, CNPJ ou CPFCNPJ válido;
CPF válido;
Precisa ser único na base;
"53.113.791/0001-22"
nameStringSim4096Nome de identificação do clienteTexto Livre"Neolog Consultoria e Sistemas S&A"
shortNameStringNão4096Como o cliente gostaria de ser chamadoTexto Livre"Neolog"
emailStringSim4096E-mail para validação do token e futuras interações com o clienteE-mail válido [email protected]"neolog@neolog.com.br"

Layout de Resposta

TPRTokenResponse: Integração rest, sincrona;
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
dateResponseDate TimeSim
Data do envio da resposta no TPRFormato ISO2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
versionStringSim4096Versão do TPR que executou a resposta-0.0.0.1
successBooleanSim
True se sucesso, False se falha-True
keyStringNão4096Chave bloqueada-
messageTPRMessage[]Sim
Campo que deve ser exibido pelo sistema externo para o usuário-Tabela abaixo

Âncora
TPRMessage
TPRMessage

TPRMessage: Tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
messageCodeStringSim4096Código de identificação da mensagemCódigo existente e validoTPR0001
messageStringSim4096Mensagem escritaTexto Livre"Para finalizar o cadastro acesse seu e-mail e valide o Token"

Âncora
TPRCatErros
TPRCatErros

Catalogo de erros

CódigoMensagemDescrição
TPRTK0001CPF ou CNPJ InválidoRetorno inválido para a validação do campo identifier
TPRTK0002E-mail InválidoRetorno inválido para a validação do campo e-mail

Anexos

Anexos