Como adicionar um número de rastreamento a um webhook
Para adicionar um número de rastreamento à assinatura de webhook usando a Advanced Integrated Visibility Tracking Number Subscription API, siga estas etapas:
- Crie um projeto de assinatura da visibilidade integrada avançada por número de rastreamento seguindo as etapas mencionadas na seção anterior ou as etapas indicadas no Guia de introdução.
- Você precisará de um token OAuth para iniciar as chamadas da Advanced Integrated Visibility Tracking Number Subscription API. Para gerar o token OAUTH, use a Authorization API. Consulte a documentação da Authorization API no catálogo de APIs para ver as etapas detalhadas de geração de token OAUTH.
- Clique na opção Detalhes do projeto no menu de navegação à esquerda. Na guia Chaves de produção, role a página para baixo até encontrar a documentação da Advanced Integrated Visibility Tracking Number Subscription API.
Na documentação da Advanced Integrated Visibility Tracking Number Subscription API, você encontrará três endpoints:
Endpoint de associação de número de rastreamento
- Use este endpoint para adicionar ou remover números de rastreamento de uma assinatura de webhook. Para saber mais, consulte a documentação da Advanced Integrated Visibility Tracking Number Subscription API.
- A adição ou remoção de números de rastreamento é um trabalho assíncrono. Uma ID de trabalho é enviada como resposta para adicionar ou remover a chamada da Tracking Number Association API.
Endpoint de detalhes do trabalho do número de rastreamento
Esse endpoint mostra detalhes sobre uma determinada ID de trabalho, como dentre todos os números de rastreamento enviados quantos foram adicionados corretamente a uma determinada assinatura de webhook ou quantos ainda estão em processamento.
Endpoint de status do trabalho do número de rastreamento
Esse endpoint permite ver o resumo atualizado de todos os trabalhos em processamento.
- Use o token AUTH gerado na etapa 2 com o endpoint de associação de número de rastreamento para adicionar números de rastreamento à assinatura de webhook.
Regras de validação:
- O nome do webhook deve ser exclusivo.
- O URL de destino do webhook deve estar no formato sintático padronizado.
- Todos os campos obrigatórios para criar um webhook devem estar preenchidos.
- Para criar um webhook, é necessário associar pelo menos um número de conta de remessa disponível da FedEx.
- Para uma validação bem-sucedida:
- Quando um webhook for criado com sucesso, o cliente receberá uma mensagem de confirmação.
Exemplo de mensagem de confirmação: <<Nome do webhook>> criado com sucesso. As alterações podem levar até 10 minutos para entrar em vigor.
- Quando um webhook for criado com sucesso, o cliente receberá uma mensagem de confirmação.
- Para uma validação malsucedida/com falha:
- Caso a FedEx receba uma resposta que não seja 200 (OK) ou 202 (Aceita), a validação do URL de destino do webhook será considerada falha.
Response