Web service Portolog: Rastreamento Automático de Transporte

Serviço web que possibilita marcar determinado DL-e para que o sistema externo receba de forma automática os rastreamentos que posteriormente sejam associados a ele. Para utilizar esse serviço os sistemas externos devem implementar um web service para recebimento destas informações de rastreamento e informar a sua respectiva URI no envio de cada uma das requisições de rastreamento automático dos DL-es que o sistema externo quer acompanhar.

Atenção:

O sistema externo deve informar, para recebimento das informações de rastreamento do forma automática, um serviço web baseado na autenticação mútua via certificados digitais, sendo portanto obrigatório o caminho possuir o protocolo "https" no início de sua URI. Também será necessário que o sistema externo possua salvo na máquina que fará essa comunicação com o Portolog as cadeias de certificados do SERPRO, para que possam reconhecer a autenticidade do Servidor do Porto Sem Papel. As cadeias de certificados são as mesmas disponíveis na página de autenticação.

Atores que podem utilizar o Serviço:

• Operador Portuário
• Terminal Portuário
• Autoridade Portuária
• ANTT
• Ponto de Controle

Endpoint do Serviço:

POST url_base/psp-portolog-rest/api/rastreamento/marca-dle/v1.00

Content-Type:

application/json

Parâmetros da Requisição de Rastreamento Automático:

Nome	Descrição	Tipo	Tamanho	Local	Observações
numDLe	Número do DL-e	Numeric(Obrigatório)	12	body
rastrear	Indica se o DL-e deve ou não ser rastreado automaticamente	Boolean(Obrigatório)	5	body	Domínio: true/false
uri	URI com o caminho do serviço para o qual o portolog deve encaminhar ou parar de encaminhar os rastreamentos de forma automática	String(Obrigatório)	100	body	(*)Somente serão aceitos caminhos que iniciem com o protocolo "https"

Observações:

1. Caso a requisição enviada ao Portolog tenha o campo "rastrear" preenchido com o valor "true" o sistema marcará o referido DL-e para ser rastreado. Posteriormente serão enviadas automaticamente requisições a URI informada pelo solicitante do rastreamento, encaminhando as informações dos rastreamentos que forem sendo associados ao referido DL-e.

2. Caso a requisição enviada ao Portolog tenha o campo "rastrear" preenchido com o valor "false", o sistema marcará o referido DL-e para parar de ser rastreado e assim não encaminhará automaticamente as informações dos novos rastreamentos que futuramente sejam associados ao DL-e.

3. A permissão para rastrear determinado DL-e, a depender do ator que encaminhou a requisição de consulta, seguirá a seguinte regra:

              - Operador ou Terminal: Será permitido o rastreamento somente dos DL-es com destino ao seu próprio terminal
              - Ponto de Controle: Será permitido o rastreamento somente dos DL-es associados ao seu próprio ponto de controle
              - Autoridade Portuária: Será permitido o rastreamento somente dos DL-es com destino ao seu porto
              - ANTT: Será permitido o rastreamento dos DL-es com destino a qualquer porto

Resposta da Requisição:

Nome	Descrição	Tipo
Mensagem	Código e descrição da Mensagem	String

Observações:

1. As mensagens de erro serão devolvidas em uma lista de String e não em um objeto JSON.

2. As informações de rastreamento que serão posteriormente encaminhadas de forma automática ao sistema externo que marcou o DL-e para ser rastreado são as mesmas que constam na resposta do Web service de consulta de rastreamento.

 

Exemplos de Arquivos JSON:

 

Exemplo da requisição de rastreamento:

        {
            "numDle":4652019, 
            "rastrear":true,
            "uri":"https://MeuHost/path"
        }

Exemplo de JSON com a resposta da requisição:

        {
            "mensagem": "[IN0043] Registro processado com sucesso."
        }

Exemplo de JSON com resposta de erro:

        [
            "[ER0008] O campo uri é inválido. O caminho informado deve iniciar com https."
        ]