Processo de Integração com o Tracking
Os processos para a integração são :
TMS Senior:
Primeiro, siga o passo a passo completo de Instalação do RBT .
Após instalação completa do RBT. Instale o RBT para Envio de Rastreamento, ative a flag FGINTEGENVHISTTRACKINGG7
E as opções:
- TRACKINGG7QTDPROCESSAINTEGENVHIST : Quantidade de históricos que serão enviados por Theads.
- TRACKINGG7MAXTHREAD : máximo de Theads em execução.
Configurações de acesso:
No módulo CFG (versão 3.18.00 ou superior) acesse o menu Cadastros > Cadastro de integração Plataforma G7, incluir os dados de acesso(Usuário e Senha que tenha acesso a plataforma), bem como as empresas que farão uso do Tracking e incluir o serviço Tracking na lista de serviços.
- URL PRODUCAO: https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/
- Não usar autenticação anônima.
Cadastro de Ocorrências
Em CCE > Cadastros > Entregas > Histórico de Entrega, a integração só é realizada para os históricos de entrega que estiverem configurados no campo Exibe Histórico com a opção Para Todos selecionada. Na guia Outros, no campo Código de Histórico para Tracking na X Plataform, deve ser informado o mesmo Código do cadastro da Fase do Tracking. Assim, com base nas configurações, o sistema entende que a ocorrência deve ser enviada para o Tracking.
CAS
Pesquise por TCK e execute os comandos não executados:
Sistema Próprio
A solução permite integrações via API. Abaixo lista de detalhamento da utilização das APIs do Tracking:
| Cadastros | ||
| Empresa | /tck/entities/empresa | - |
| Filial | /tck/entities/filial | Possui relacionamento com a entidade Empresa |
| Fase | /tck/entities/fase | - |
| Plano | /tck/entities/plano | - |
| Fases do Plano | /tck/entities/planoFase | Vinculo entre as entidades Plano e Fase |
| Movimentações | ||
| Salva Tracking | /tck/actions/salvaTracking | Anexo esta os campos que precisam ser enviados, com comentários mais detalhados |
| Altera Fase | /tck/actions/executaTrackingFase | Utilizada para alterar os dados da fase referente ao tracking, como por exemplo, alterar a fase para executada ou definir uma data de previsão |
| Cancela fase |
/tck/actions/cancelaTrackingFase |
Utilizada para desfazer a execução da fase, caso tenha sido enviado ingratamente |
| Transfere Tracking | /tck/actions/transfereTracking | Utilizada para criar um novo Tracking a partir do criado pelo ERP, vinculando o documento criado no WMS. |
| Tipo Documento | /tck/actions/atualizaOrdenacaoTipoDocumento | Utilizada para receber uma lista de id ou código do tipo de documento para que seja atualizada a ordenação. |
Exemplo JSONG SALVATRACKING:
"codigoPlano": "string", //Código do Plano que o tracking irá seguir (/tck/entities/plano)
"cnpjFilial": "string", //CNPJ da filial que o tracking pertence (/tck/entities/filial)
"codigoTracking": "string", //Caso seja um tracking novo, não enviar esse campo
"listaTrackingFase": [ //Lista de fases que foram executadas ou que possuem previsão de execução
{
"executada": true, // somente quando a fase for executada
"dataExecucao": "2020-10-09T14:17:18.698Z", // data da execução da fase
"previsaoExecucao": "2020-10-09T14:17:18.698Z", // data da previsão da execução
"fase": {
"codigo": 0, //Código da fase (/tck/entities/fase)
"contatosNotificacao": [ //Lista de contato que receberá a notificação
{
"nome": "string", //Nome do contato
"telefone": "string", //Telefone do contato
"enderecoCompleto": "string" //Endereço do contato
}
],
"mensagemCompleta": "string" //Mensagem que será enviada na notificação, caso não seja preenchida, o serviço irá buscar a notificação vinculada no cadastro de fase
}
}
],
"listaDocumento": [ //Lista dos documentos vinculados ao tracking
{
"numero": "string", //Número do documento
"serie": "string", //Série do documento
"identificadorCliente": "string",//Aqui seria o CNPJ da empresa que emitiu o documento chave do cliente/empresa no sistema para logar no portal, por padrão enviar CPF/CNPJ
"tipoDocumento": {
"codigo": "string" //Código do tipo de documento (/tck/entities/tipoDocumento)
}
}
],
"listaCliente": [ //Lista de clientes que não tem vinculo ao documento, mas que poderá visualizar este tracking
{
"nome": "string", //Nome do cliente
"inscricaoFiscal": "string", //CPF/CNPJ dos clientes que não estão relacionados no documento
"tipoInscricaoFiscal": 0, //1 = CPF, 2 = CNPJ, mas isso não é obrigatório
"ativo": true
}
],
"listaClienteDocumento": [ //Lista do clientes relacionados aos documentos (ex: remetente, destinatário). Informar os mesmo documentos listados no objeto "listaDocumento"
{
"cliente": {
"nome": "string",
"inscricaoFiscal": "string",
"tipoInscricaoFiscal": 0,
"ativo": true
},
"documento": {
"numero": "string",
"serie": "string",
"identificadorCliente": "string",
"ativo": true,
"tipoDocumento": {
"codigo": "string" //Código do tipo de documento (/tck/entities/tipoDocumento)
}
},
"tipoClienteRec": { //Define o relacionamento do cliente com o documento (ex: remetente, destinatario, tomador)
"codigo": "string" //Código do tipo do cliente (/tck/entities/tipoCliente)
}
"ativo": true
}
]
}
| Consultas | ||
| Tracking | /tck/queries/consultaTracking | |
|
Tracking consulta externa |
/tck/actions/externalTenantConsultaTracking |
Essa consulta necessita que seja informado no header as chaves ‘X-Tenant’ e ‘X-TenantDomain’. Para mais informações consultar o link da documentação de como utilizar o tracking |
| Tracking consulta detalhe | /tms/tck/queries/consultaTrackingDetalhe | Essa consulta do Tracking é para que seja utilizada por outros sistemas afim de retornar todas as informações relacionadas ao tracking desejado, de forma detalhada. |
ExternalTenantConsultaTracking, Clique aqui e acesse documentação
- Necessita autenticação: Não.
- Versão: 3.0
- Requisição:https://platform.senior.com.br/t/senior.com.br/bridge/1.0/anonymous/rest/tms/tck/actions/externalTenantConsultaTracking
Parâmetros da requisição:
Header:
| Chave | Valor | Descrição |
|
Content-Type |
Application/json | Tipo do retorno da requisição |
| X-Tenant | TENANT | TENANT que será realizada a requisição Ex.: Inquilino: tms-homologacao |
| X-TenantDomain | Domínio do TENANT | Domínio do TENANT que será realizada a requisição Ex.: Domínio: tms-homologacao.com.br |
Exemplo Postman:
Para localizar o Tenant e x-TenantDomain nas Configurações de inquilino, clique aqui e confira documentação.
Body:
Exemplo Postman:
Campos com “?” no final do tipo não são obrigatórios.
Campos com “*” no final do tipo são listas.
| Nome | Tipo | Descrição |
| codigoTracking | String(255)? | Código do Tracking. |
| inscricaoFiscal | String(255)? | CPF/CNPJ do emitente do tracking. |
| documento | String(255)? | Número do documento. |
| serie | String(255)? | Serie do documento. |
| identificadorCliente | String(255)? | CPF/CNPJ do cliente vinculado ao documento. |
| tipoDocumento | Record(TipoDocumento)? | Tipo de Documento. |
| pageRequest | Record(RecPageRequest)? | Parametros para filtro e ordenação. |
TipoDocumento:
| Nome | Tipo | Descrição |
| id | String(255)? | Identificador único do Tipo de documento. |
| descricao | String(255) | Descrição do tipo. |
| ativo | Boolean? | Situação Ativado/Desativado. |
RecPageRequest:
| Nome | Tipo | Descrição |
| offset | Integer? | Número da página. |
| size | Integer? | Quantidade de registros por página. |
| orderBy | Record(RecFieldsOrderBy)?* | Campos da ordenação dos registros a serem pesquisados. |
RecFieldsOrderBy:
| Nome | Tipo | Descrição |
| field | String(255) | Nome do campo a ser ordenado. |
| order | Enumeration(EnumTypeOrder) | Tipo de ordenação do campo (ASC / DESC). |
EnumTypeOrder:
| Nome | Descrição |
| ASC | Tipo crescente. |
| DESC | Tipo decrescente. |
Para mais detalhes sobre APIs e Layouts, clique aqui
English
Español
English
Español


