Totvs Planejamento de Rotas

Árvore de páginas

Versões comparadas

Versão antiga 70

changes.mady.by.user Julio Vinicius Oliveira dos Santos

Gravado em

comparado com

Nova versão 71

changes.mady.by.user Julio Vinicius Oliveira dos Santos

Gravado em

Chave

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

Introdução

draw.io Diagram
borderfalse
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxtrue
revision1
diagramNameTPR_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
borderfalse
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxtrue
revision1
diagramNameTPR_token_macro
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth656


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
TPRCatMsg
TPRCatMsg

Catalogo de Mensagens (Externo)

CódigoMensagemDescrição
TPRTK0000SucessoRetorno indicando sucesso da operação
TPRTK0001Erro ao usar algum serviço do Google Cloud PlatformRetorno de erro de conexão com o banco de dados ou de pubsub
TPRTK0002Id é obrigatórioRetorno inválido para a validação de atualização de token do campo id, já que se encontra nulo ou vazioTPRTK0003Token não encontrado
Retorno indicando que o token que deseja fazer a operação não foi encontrado.
TPRTK0004Data da criação de chamada no sistema externo é obrigatórioRetorno inválido para a validação do campo dateCall, já que se encontra nulo ou vazio
TPRTK0005Tipo de identificador é obrigatórioRetorno inválido para a validação do campo identifierType, já que se encontra nulo ou vazio
TPRTK0006Identificador é obrigatórioRetorno inválido para a validação do campo identifier, já que se encontra nulo ou vazio
TPRTK0007CNPJ está inválidoRetorno inválido para a validação do campo identifier, já que está diferente do formato esperado dos CNPJs
TPRTK0008CNPJ já está em uso para outro tokenRetorno inválido para a validação do campo identifier, já que está sendo usado em outro registro
TPRTK0009CPF está inválidoRetorno inválido para a validação do campo identifier, já que está diferente do formato esperado dos CPFs
TPRTK0010CPF já está em uso para outro tokenRetorno inválido para a validação do campo identifier, já que está sendo usado em outro registro
TPRTK0011Nome é obrigatórioRetorno inválido para a validação do campo name, já que se encontra nulo ou vazio
TPRTK0012E-mail é obrigatórioRetorno inválido para a validação do campo email, já que se encontra nulo ou vazio
TPRTK0013E-mail está inválidoRetorno inválido para a validação do campo email, já que está diferente do formato esperado de um e-mail ([email protected])
TPRTK0014Qualifiers não estão em um formato JSON válidoRetorno inválido para a validação do campo qualifiers, já que está diferente do formato esperado de um objeto JSON em texto
TPRTK0015TPRTK0016Data de expiração está inválidaRetorno inválido para a validação do campo expirationDate, já que está sendo escolhida uma data de expiração no passado
Data de expiração é obrigatórioRetorno inválido para a validação do campo expirationDate, já que se encontra nulo ou vazio
TPRTK0017Formato inválidoRetorno indicando que a mensagem está diferente do contrato indicado acima, logo se encontra num formato inválido
TPRTK0018Campo de datetime enviado em formato inválidoRetorno indicando que algum campo que seja datetime está com formatação inválido
TPRTK0019Nome do campo a ser filtrado é obrigatórioRetorno inválido para a validação do campo fieldName para filtro, já que se encontra nulo ou vazioTPRTK0020Valor do filtro é obrigatórioRetorno inválido para a validação do campo value para filtro, já que se encontra nulo ou vazioTPRTK0021Nome do campo a ser filtrado está inválidoRetorno inválido para a validação do campo fieldName para filtro, já que está fora das opções dos campos que podem ser filtrados (identifier, name, shortName, email, active)
TPRTK0022Tipo de identificador está inválidoRetorno inválido para a validação do campo identifierType, já que se encontra diferente dos valores possíveis (CPF, CNPJ)
TPRTK0023O valor do sistema possui mais de 4096 caracteresRetorno inválido para a validação do campo system, porque é maior que 4096 caracteres
TPRTK0024O valor da versão possui mais de 4096 caracteresRetorno inválido para a validação do campo version, porque é maior que 4096 caracteres
TPRTK0025O valor de qualifiers possui mais de 4096 caracteresRetorno inválido para a validação do campo qualifiers, porque é maior que 4096 caracteres
TPRTK0026O valor do identificador possui mais de 4096 caracteresRetorno inválido para a validação do campo identifier, porque é maior que 4096 caracteres
TPRTK0027O valor do nome possui mais de 4096 caracteresRetorno inválido para a validação do campo name, porque é maior que 4096 caracteres
TPRTK0028O valor do apelido possui mais de 4096 caracteresRetorno inválido para a validação do campo shortName, porque é maior que 4096 caracteres
TPRTK0029O valor do email possui mais de 4096 caracteresRetorno inválido para a validação do campo email, porque é maior que 4096 caracteres

Catalogo de Mensagens (Interno)

CódigoMensagemDescrição
TPRTK0002Id é obrigatórioRetorno inválido para a validação de atualização de token do campo id, já que se encontra nulo ou vazio
TPRTK0003Token não encontradoRetorno indicando que o token que deseja fazer a operação não foi encontrado.
TPRTK0015Data de expiração é obrigatórioRetorno inválido para a validação do campo expirationDate, já que se encontra nulo ou vazio
TPRTK0016Data de expiração está inválidaRetorno inválido para a validação do campo expirationDate, já que está sendo escolhida uma data de expiração no passado
TPRTK0019Nome do campo a ser filtrado é obrigatórioRetorno inválido para a validação do campo fieldName para filtro, já que se encontra nulo ou vazio
TPRTK0020Valor do filtro é obrigatórioRetorno inválido para a validação do campo value para filtro, já que se encontra nulo ou vazio
TPRTK0021Nome do campo a ser filtrado está inválidoRetorno inválido para a validação do campo fieldName para filtro, já que está fora das opções dos campos que podem ser filtrados (identifier, name, shortName, email, active)

Anexos

Anexos