A Subscrição de número de rastreio da Visibilidade integrada avançada foi criada para os subscritores da Visibilidade integrada avançada gerirem os respetivos projetos de webhook baseados em números de rastreio e realizar operações relacionadas com projetos, como adicionar novos números de rastreio, editar ou ver detalhes de tarefas com pontos finais da API.

Nota:

• Tem de ter acesso de administrador ou contribuidor para o seu projeto de Visibilidade integrada avançada
• Para obter mais informações sobre a Visibilidade integrada avançada e as respetivas funcionalidades, aceda à página da documentação da Visibilidade integrada avançada.

As vantagens da Subscrição do número de Rastreio da Visibilidade integrada avançada são:

• Pode atualizar e gerir facilmente o os números de Rastreio do seu projeto de Visibilidade integrada avançada com os pontos finais da API.
• Esta API permite-lhe associar vários números de Rastreio ao seu projeto numa única transação de API, em vez de associar cada número de Rastreio separadamente.
• Pode enviar pedidos de API de forma consecutiva e ver detalhes de registo do sucesso/das falhas destes pedidos.

Utilize os pontos finais abaixo para gerir o projeto de Visibilidade integrada avançada:

Só é possível aceder a esta API através da descrição geral do seu projeto, conforme representado na captura de ecrã acima.

Utilize este ponto final para acionar uma tarefa assíncrona para associar um ou vários números de Rastreio a um projeto de Visibilidade integrada avançada específico.

As informações de introdução obrigatória deste pedido são:

• Ação – Especifique a ação a ser efetuada quando envia o pedido. Exemplo: ADICIONAR
• Detalhes do número de Rastreio – Especifique o número de Rastreio

Pode associar no máximo 1000 números de Rastreio a um único pedido. A resposta bem-sucedida a este pedido irá devolver o jobID, o estado da tarefa atual e o registo de data/hora da criação da tarefa e da conclusão da tarefa. Este jobId pode ser posteriormente utilizado para verificar o estado da tarefa assíncrona.

Utilize este ponto final para obter o estado de uma tarefa assíncrona (um ou mais pedidos consecutivos em fila) ou o estado de todas as tarefas enviadas.

As informações de introdução obrigatória deste pedido são:

• ID da tarefa – especifique a ID da tarefa da qual pretende obter o estado.

Nota: a ID da tarefa é uma entrada opcional para este ponto final. Se não especificar a ID da tarefa, irá obter os estados de todas as tarefas enviadas.

A resposta bem-sucedida a este pedido irá devolver o jobID, o estado da tarefa atual e o registo de data/hora da criação da tarefa e da conclusão da tarefa. A resposta irá apresentar o estado atual das tarefas. Além disso, a resposta também irá conter mensagens de sucesso, erros ou avisos para os utilizadores verem e resolverem os respetivos problemas, conforme aplicável.

• Se o estado da tarefa for apresentado como CONCLUÍDA, significa que todos os números de Rastreio foram validados e processados com sucesso.
  • O estado CONCLUÍDA indica que os números de Rastreio foram validados e processados com sucesso. Não indica que todos os números de Rastreio foram adicionados com sucesso ao projeto de Visibilidade integrada avançada.
  • Se tentar associar vários números de Rastreio e apenas alguns deles forem associados e os restantes falharem a associação, o estado da tarefa continuará a ser atualizado como CONCLUÍDA. Para confirmar o estado de cada número de Rastreio no pedido de associação, o relatório de lote tem de ser transferido.

Nota:

• Se o estado da tarefa for apresentado como FALHOU, significa que, devido a vários motivos/falhas, não foi possível processar o pedido e o utilizador tem de tentar novamente.

Seguem-se os estados e as respetivas descrições:

Utilize este ponto final para transferir o relatório JSON para uma tarefa assíncrona que está com o estado CONCLUÍDA.

As informações de introdução obrigatória associadas a este pedido são:

• ID da tarefa – especifique a ID da tarefa da qual pretende obter o estado.

Nota:

• A ID da tarefa é uma entrada obrigatória para este ponto final.
• Só pode transferir o relatório de uma tarefa assíncrona de cada vez.
• Se a tarefa não estiver CONCLUÍDA e tentar transferir o relatório, é apresentada uma mensagem de erro.

A resposta bem-sucedida a este pedido fornece-lhe o relatório da tarefa no formato JSON.

• Podem ser associados, no máximo, 1000 números de Rastreio de expedição a um projeto de Visibilidade integrada avançada em cada pedido.
• Não existe um limite para o máximo de números de Rastreio que pode associar a um determinado projeto de Visibilidade integrada avançada.
• Quaisquer números de Rastreio associados serão dissociados passados 40 dias desde um determinado projeto de Visibilidade integrada avançada.
• Quaisquer detalhes e estados de ID da tarefa criados deixarão de estar disponíveis após 90 dias para um determinado projeto de Visibilidade integrada avançada.
• As informações de Rastreio protegidas, como o endereço do destinatário e a assinatura do destinatário, não serão disponibilizadas através da Subscrição do número de Rastreio da Visibilidade integrada avançada.