FoccoSMF - Rastreio de Documentos¶

Utilização de Serviços Consulta de Dados de Rastreio¶

Os serviços de consulta de dados de rastreio 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>/RastreioDocumentos/<SERVIÇO> do FoccoSMF.

Ex: http://localhost:8878/RastreioDocumentos/ConsultaRastreioDocumentos

1. Envio de Tarefas para o FoccoSMF¶

1.1 - JSON de envio de Tarefas¶

Atributo	Informação
Chave de Acesso	Chave do ambiente do cliente do FoccoERP.
Modelo	Modelo de serviço do FoccoSMF, utilizar "RASTREIO_DOCUMENTOS".
CodigoGenerico	Deve ser utilizado o mnemonico cadastradado no ERP para a plataforma de rastreio.
RastreioDocumentos	Objeto que contém as informações necessárias para realizar as consultas de rastreios.

Exemplo:

{
    "RastreioDocumentos": { },
    "ChaveAmbiente": "DB05D766-0F3D-4D8B-AB5D-36DDB804E4D8",
    "Producao": 0,
    "Versao": null,
    "Modelo": "RASTREIO_DOCUMENTOS",
    "Cnpj": null,
    "CodCidade": null,
    "CodUfIbge": null,
    "CodigoGenerico": "SSW"
}

1.2 - 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	Informação
Token	Token/chave da tarefa criada no FoccoSMF, que será utilizada para consulta do resultado da tarefa.
Status	Status/situação da tarefa no FoccoSMF. Situações possíveis: Pendente, Sucesso e Falha.
Modelo	Modelo de serviço do FoccoSMF, será o modelo utilizado no envio, no caso "RASTREIO_DOCUMENTOS".
Acao	Identifica a ação/método executado pela tarefa, será o serviço utilizado. Exemplo:"ConsultaRastreioDocumentos"
Resultado	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": "RASTREIO_DOCUMENTOS",
    "Acao": "ConsultaRastreioDocumentos",
    "Resultado": null
}

2 - Consuta de Rastreios por Plataforma¶

2.1. - Serviço de Envio de Consulta de Rastreio¶

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

JSON: Enviado no objeto "RastreioDocumentos" do Json de Envio de Tarefas (Item 1.1)

Atributo	Tipo	Informação	Obrigatório
Documentos	List\<object>	Lista de documentos.	Sim
Documentos.Identificador	string	Identificador do documento que será enviado para a plataforma de rastreio.	Sim
TokenAcesso	string	Token de acesso à API da plataforma de rastreio.	Não

"Documentos": 
[
    {
        "Identificador": "42201109376495000122550010013417431046403271",
        "TokenAcesso": "10d7312d661d9c4bf26b81b91de4add07726df123fa22faf2f70517c6e49b2efaf1dd1bedc8bec288032318f81a41a668363d85e0c85634d585e84fa81179ef2"
    }
]

2.2. - Retorno do serviço de consulta de Rastreio¶

Atributo	Tipo	Informação
Plataforma	String	Identificador da plataforma de rastreio.
Documentos	List\<objeto>	Lista de documentos retornados pela plataforma.
Identificador	String	Identificador do documento consultado.
Status	String	Status da requisição do Documento. Possíveis Satus: S - Sucesso; F - Falha
Mensagem	String	Mensagem que descreve os motivos para os status.
Rastreios	List\<objeto>	Lista de rastreios do documento.
DataHora	DateTimeOffset	Data e hora do lançamento do rastreio.
Ocorrencia	String	Informação sobre qual o status da ocorrência.
Local	String	Local onde foi registrada a ocorrência.
Tipo	String	Identifica qual o tipo da ocorrência. Tipos Disponíveis: I - Informativo; E - Entregue
Observações	String	Observações relacionadas a ocorrência.