FoccoSMF - TMS¶

Utilização de Serviços de Envio e Consulta de Dados de TMS¶

Os serviços de envio e consulta de dados para plataformas TMS utilizam comunicação via REST e o modelo de dados retornado varia dependendo da plataforma consultada, podendo ser JSON ou XML.

A URL base para utilização dos serviços é o http://<IP>:<PORTA>/Tms/<SERVIÇO> do FoccoSMF.

Ex: http://localhost:8877/Tms/ConsultarCte

1. Envio de Tarefas para o FoccoSMF¶

1.1 - JSON de envio de Tarefas¶

Atributo	Tipo	Informação
Chave Ambiente	string	Chave do ambiente do cliente do FoccoERP.
Modelo	string	Modelo de serviço do FoccoSMF, utilizar "TMS".
Cnpj	string	CNPJ da empresa com a integração TMS configurada.
CodigoGenerico	string	Mnemonico cadastradado no ERP para a plataforma de TMS.
UrlBase	string	URL base do TMS. Exemplo: https://eagle.lognex.com.br/api
Usuario	string	Usuário de acesso à plataforma do TMS.
Senha	string	Senha de acesso à plataforma do TMS.

Exemplo:

{
    "ChaveAmbiente": "DB05D766-0F3D-4D8B-AB5D-36DDB804E4D8",
    "Modelo": "TMS",
    "Cnpj": "93200111000122",
    "CodigoGenerico": "LOGNEX",
    "UrlBase": "https://eagle.lognex.com.br/api",
    "Usuario": "usuario",
    "Senha": "senha"
}

1.2 - JSON de envio para consulta de resultado de tarefas¶

URL: <URL base para utilização dos serviços>/service/GetTaskResult

Atributo	Informação
ChaveAmbiente	Chave do ambiente do cliente do FoccoERP.
Token	Token/chave da tarefa criada no FoccoSMF, que será utilizada para consulta do resultado da tarefa.

Exemplo

{
    "ChaveAmbiente": "FB9BD7CF-4DD7-4ECE-955B-464AE41D2004",
    "Token": "4041A17B-D946-4233-840A-6281DA13BF28"
}

1.3 - JSON de retorno do FoccoSMF¶

Essa estrutura de retorno é tanto para o agendamento de tarefas, quanto para a consulta de situação de tarefas.

Atributo	Tipo	Informação
Token	string	Token/chave da tarefa criada no FoccoSMF, que será utilizada para consulta do resultado da tarefa.
Status	string	Status/situação da tarefa no FoccoSMF. Situações possíveis: Pendente, Sucesso e Falha.
Modelo	string	Modelo de serviço do FoccoSMF, será o modelo utilizado no envio, no caso "TMS".
Acao	string	Identifica a ação/método executado pela tarefa, será o serviço utilizado. Exemplo:"ConsultarCte"
Resultado	Status	Retorna o resultado da execução da tarefa.

Observação¶

Como o SMF executa suas tarefas de forma assíncrona, o retorno será sempre null quando for realizado o envio da requisição. O resultado deve ser consultado posteriormente para se obter um resultado diferente de null quando o Status da requisição for diferente de Pendente

Exemplo

{
    "Token": "F061789A-383A-45CA-9BB9-3425F26345BA",
    "Status": "Pendente",
    "Modelo": "TMS",
    "Acao": "ConsultarCte",
    "Resultado": null
}

2 - Consuta de Conhecimento de Frete Eletrônico por Plataforma¶

2.1. - Serviço de Envio de Consulta de Conhecimento de Frete Eletrônico¶

URL: <URL base para utilização dos serviços>/ConsultarCte

JSON: Objeto do Json de Envio de Tarefas (Item 1.1)

Exemplo:

{
    "ChaveAmbiente": "DB05D766-0F3D-4D8B-AB5D-36DDB804E4D8",
    "Modelo": "TMS",
    "Cnpj": "93200111000122",
    "CodigoGenerico": "LOGNEX",
    "UrlBase": "https://eagle.lognex.com.br/api",
    "Usuario": "usuario",
    "Senha": "senha"
}

2.2. - Retorno do Serviço de Envio de Consulta de Conhecimento de Frete Eletrônico¶

Atributo	Tipo	Informação
Plataforma	string	Identificador da plataforma TMS.
Cnpj	string	CNPJ da empresa com a integração TMS configurada.
DocumentosAprovados	List\<objeto>	Lista de documentos retornados pela plataforma.
DocumentosAprovados.NumeroDocumento	long	Número do CT-e consultado.
DocumentosAprovados.Serie	string	Série do CT-e consultado.
DocumentosAprovados.ChaveAcesso	string	Chave de Acesso do CT-e consultado.
DocumentosAprovados.CodigoRastreio	string	Código de Rastreio do CT-e consultado.

Exemplo:

{
    "Plataforma": "LOGNEX",
    "Cnpj": "93200111000122",
    "DocumentosAprovados": [
        {
            "NumeroDocumento": 134737,
            "Serie": "2",
            "ChaveAcesso": "43210992604420000103570020001347371061347376",
            "CodigoRastreio": "217474"
        }
    ]
}

3 - Confirmação de Pagamento de Conhecimento de Frete Eletrônico por Plataforma¶

3.1. - Serviço de Envio de Confirmação de Pagamento de Conhecimento de Frete Eletrônico¶

URL: <URL base para utilização dos serviços>/ConfirmarPagamentoCte

Atributo	Tipo	Informação
Chave Ambiente	string	Chave do ambiente do cliente do FoccoERP.
Modelo	string	Modelo de serviço do FoccoSMF, utilizar "TMS".
Cnpj	string	CNPJ da empresa com a integração TMS configurada.
CodigoGenerico	string	Mnemonico cadastradado no ERP para a plataforma de TMS.
UrlBase	string	URL base do TMS. Exemplo: https://eagle.lognex.com.br/api
Usuario	string	Usuário de acesso à plataforma do TMS.
Senha	string	Senha de acesso à plataforma do TMS.
Tipo	string	Tipo do Documento do CT-e.
CodigoRastreio	string	Código de Rastreio do CT-e.

Exemplo:

{
    "ChaveAmbiente": "DB05D766-0F3D-4D8B-AB5D-36DDB804E4D8",
    "Modelo": "TMS",
    "Cnpj": "93200111000122",
    "CodigoGenerico": "LOGNEX",
    "UrlBase": "https://eagle.lognex.com.br/api",
    "Usuario": "usuario",
    "Senha": "senha",
    "Tipo": "CTE",
    "CodigoRastreio": "217474"
}

3.2. - Retorno do Serviço de Envio de Confirmação de Pagamento de Conhecimento de Frete Eletrônico¶

Atributo	Tipo	Informação
Plataforma	string	Identificador da plataforma TMS.
Cnpj	string	CNPJ da empresa com a integração TMS configurada.
Conteudo	string	Conteúdo retornado pela plataforma TMS.

Exemplo:

```json { "Plataforma": "LOGNEX", "Cnpj": "93200111000122", "Conteudo": "Pagamento realizado com Sucesso" }