Para adicionar um número de rastreio à sua subscrição de webhook com a Tracking Number Subscription API da Visibilidade integrada avançada, siga os passos abaixo:

1. Crie um projeto de Subscrição da Visibilidade integrada avançada baseada em números de Rastreio com os passos na secção anterior, ou com os passos fornecidos no Guia de introdução.
2. Precisa de um token OAuth para iniciar chamadas da Advanced Integrated Visibility Tracking Number Subscription API. Para gerar o token OAUTH, utilize a Authorization API. Consulte a documentação da Authorization API no catálogo da API para obter os passos detalhados para gerar um token OAUTH.
3. Clique na opção Detalhes do projeto no painel de navegação à esquerda. No separador Chaves de produção, navegue para baixo para encontrar a documentação da Advanced Integrated Visibility Tracking Number Subscription API.

Quando aceder à documentação da Advanced Integrated Visibility Tracking Number Subscription API vai encontrar três pontos finais:

Ponto final Associação de números de rastreio

• Utilize este ponto final para adicionar ou remover números de Rastreio de uma determinada Subscrição de webhook. Para obter mais detalhes, consulte a documentação da advanced integrated visibility tracking number subscription API.
• Qualquer adição ou remoção dos números de rastreio é uma tarefa assíncrona. A ID da tarefa é enviada como resposta à chamada da tracking number association API para adicionar ou remover.

Ponto final Detalhes de tarefas de números de rastreio

Este ponto final fornece detalhes sobre uma determinada ID da tarefa, por exemplo, de todos os números de rastreio enviados, quantos foram adicionados com sucesso a uma determinada subscrição de webhook ou quantos ainda estão a ser processados.

Ponto final Estado de tarefas de números de rastreio

Este ponto final permite-lhe obter um resumo atual de todas as tarefas que estão a ser processadas.

1. Utilize o token AUTH gerado no Passo 2 com o ponto final Associação de números de rastreio para adicionar números de rastreio à sua subscrição de webhook.

Regras de validação:

• O nome do webhook deve ser único.
• O URL de destino de webhooks tem de estar no formato sintático padrão.
• Todos os campos necessários para criar um webhook não podem estar vazios.
• Deve ser associado pelo menos um número de conta de expedição FedEx disponível para criar um webhook.
• Para uma validação com sucesso:
  • Quando um webhook for criado com sucesso, o cliente irá receber uma mensagem de confirmação.

    Mensagem de confirmação de exemplo: <<Webhook name>> criado com sucesso. As alterações podem demorar até 10 minutos para entrarem em vigor.

• Para uma validação sem sucesso/com falhas:
  • Se a FedEx receber respostas além de 200 (OK) ou 202 (Accepted), a validação do URL de destino de webhook será considerada sem sucesso.