Fedex Logo

CRIAR UM
WEBHOOK GERIR WEBHOOKS

Como funciona a Visibilidade integrada avançada

O webhook de Visibilidade integrada avançada permite que a FedEx envie atualizações de rastreio seguras e praticamente em tempo real para um URL específico. Estas atualizações destinam-se a expedições associadas a um ou mais números de conta FedEx. Para utilizar esta funcionalidade, tem de criar um projeto de webhook de Visibilidade integrada avançada.

Como aceder à página Visibilidade integrada avançada

Pode aceder à configuração de Visibilidade integrada avançada de duas formas:

Opção 1: através de Os meus projetos

    1. Aceda a Os Meus Projetos no painel de navegação à esquerda.

    2. Clique no separador Webhooks.

    3. Selecione +CRIAR UM PROJETO DE WEBHOOK.

Opção 2: através do Catálogo de API

    1. Abra o Catálogo de API no painel de navegação à esquerda.

    2. Pesquise por Visibilidade integrada avançada.

    3. Utilize o filtro de WEBHOOK para encontrar o cartão correto.

    4. No cartão:

  •  Clique em Descrição geral, depois no botão Documentação e escolha +CRIAR UM PROJETO DE WEBHOOK.
  •  Em alternativa, aceda a Documentos e clique em +CRIAR UM PROJETO DE WEBHOOK.

 

Passo 1: selecione o tipo de empresa

Clique em +CRIAR UM PROJETO e selecione o seu tipo de empresa a partir da lista de opções:

    1. Envia com a FedEx e tem de integrar o webhook FedEx no seu sistema.

    2. Comercializa ou fornece uma solução de software que utiliza dados da FedEx e não é um Fornecedor compatível FedEx certificado.

    3. É um Fornecedor compatível FedEx certificado.

 

Em seguida, selecione Subscrição baseada em números de rastreio da Visibilidade integrada avançada como o seu tipo de subscrição.

Crie uma Subscrição baseada em números de rastreio da Visibilidade integrada avançada

Pode configurar uma Subscrição baseada em números de rastreio da Visibilidade integrada avançada para receber atualizações de rastreio seguras e praticamente em tempo real para um ou mais números de rastreio FedEx. Estas atualizações são enviadas para um URL de destino que especificar.

 

Passos para criar a subscrição

O processo envolve quatro passos principais:

    1. Configurar projeto

    2. Introduzir os detalhes do projeto

    3. Confirmar os detalhes e aceitar os termos

    4. Adicionar números de rastreio

 

Instruções passo a passo

    1. Na página Configurar o webhook:

         Verifique o número da conta de faturação

         Será apresentado o número de conta de faturação predefinido da sua organização.

         Para alterar:

  •  Clique em ADICIONAR CONTA DE FATURAÇÃO À SUA ORGANIZAÇÃO (se tiver apenas uma conta) ou
  •  Clique em SELECIONAR OUTRA CONTA DE FATURAÇÃO (se tiver várias contas).

 

Nota: para obter detalhes de preços, aceda à página Descrição geral da Visibilidade integrada avançada.

 

2. Selecionar funcionalidades

  •  Selecione as funcionalidades de que precisa.
  •  Clique em Seguinte para continuar.

Sugestão: para saber mais sobre cada funcionalidade, clique no ícone de ajuda (?) junto à mesma.

Descrições das funcionalidades

Nome do Campo Descrição
Prova de Entrega Confirma que uma expedição foi entregue com sucesso. Inclui:
  • Prova de entrega em fotografia (PPODA): fornece uma foto que mostra o local exato da entrega.
  • Assinatura como prova de entrega (SPOD): fornece uma imagem da assinatura do destinatário, nome, data, hora e local da entrega.
Entrega estimada Ajuda os destinatários a planear ao fornecer:
  • Data de entrega estimada (EDD)
  • Intervalo de tempo da entrega estimada (EDTW)
Eventos de rastreio Permite selecionar uma ou mais categorias de eventos para receber notificações:
  • Expedir
  • Em trânsito
  • Entrega
  • Exceções

 

Na página Inserir detalhes, forneça as seguintes informações:

Nome do Campo Descrição
Nome do projeto de webhook Um nome único e não vazio para o seu projeto de webhook. Um nome sugerido é preenchido automaticamente, mas pode ser editado. Este nome não pode ser repetido em nenhum outro webhook.
URL de destino O ponto final HTTPS seguro para onde a FedEx irá enviar dados de eventos de rastreio.
Requisitos:
  • Tem de estar válido e a funcionar
  • Tem de seguir a sintaxe padronizada
  • Não pode incluir fedex.com ou respetivos subdomínios
  • Pode ser reutilizado em vários webhooks
Consulte a secção Regras empresariais e boas práticas para mais detalhes.
Token de Segurança Um segredo partilhado utilizado para autenticar e validar respostas de webhook através de HMAC.
Requisitos:
  • 26 a 100 carateres
  • A palavra-passe tem de ter, pelo menos, 1 letra maiúscula, 1 letra minúscula e 1 um caráter numérico
  • Pode ser reutilizado em vários webhooks
Idioma da carga (país) Selecione o idioma preferencial da tradução de dados de rastreio a partir da lista de opções.
Tipo de Rastreio Escolha a forma como os dados de rastreio devem ser entregues:
  • Rastreio detalhado – Histórico completo de eventos
  • Rastreio específico do evento – Apenas o evento mais recente
Endereço de E-mail Introduza um endereço de e-mail válido para receber notificações.
Idioma do e-mail (país) Selecione o idioma preferencial para as notificações por e-mail.
Nota: apenas as regiões dos EUA são suportadas (por ex., en-US, es-US).

3. Na página Confirmar detalhes:

  •  Reveja os detalhes do projeto de webhook.
  •  Marque a caixa para aceitar os Termos e Condições.
  •  Clique em Criar para concluir a configuração do projeto de webhook.

4. Assim que o seu pedido for enviado com sucesso:

  •  A FedEx vai criar um novo Projeto de webhook.
  •  Irá receber chaves de produção da Tracking Number Subscription API da Visibilidade integrada avançada.
  •  Pode utilizar esta API para associar números de rastreio ao seu projeto.

Para obter mais informações, consulte a página de documentação da Tracking Number Subscription API da Visibilidade integrada avançada.

Como adicionar um Número de rastreio a um webhook

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

 

Processo passo a passo

1. Criar um Projeto de subscrição

· Utilize os passos da secção anterior ou consulte o Guia de introdução.

2. Gerar um token OAuth

  •  Precisa de um token OAuth para efetuar chamadas à API.
  •  Utilize a Authorization API para gerar o token.
  •  Consulte a documentação da Authorization API no Catálogo de API para obter passos detalhados.

3. Aceder à documentação da API

  • No menu de navegação à esquerda, clique em Detalhes do projeto.
  • No separador Chaves de produção, navegue para encontrar a documentação da Tracking Number Subscription API da Visibilidade integrada avançada.

Visão geral dos pontos finais da API

Ponto final Finalidade
Associação de números de rastreio Adicionar ou remover números de rastreio de uma subscrição de webhook. Esta é uma tarefa assíncrona. É devolvido um ID de tarefa na resposta.
Detalhes da tarefa do número de rastreio Fornece detalhes para um ID da tarefa específico, por exemplo, quantos números de rastreio foram adicionados com sucesso ou ainda estão a ser processados.
Estado da tarefa do número de rastreio Devolve um resumo de todas as tarefas a ser processadas atualmente.

 

Utilize o token OAuth do Passo 2 com o ponto final Associação de números de rastreio para adicionar números de rastreio ao seu webhook.

Regras de validação

  •  O nome do Webhook tem de ser único.
  •  O URL de destino tem de seguir um formato sintático padrão.
  •  Todos os campos obrigatórios têm de ser preenchidos.
  •  É obrigatório associar, pelo menos, um número de conta de expedição FedEx válido.

 

Resultados da validação

Estado Detalhes
Com sucesso É apresentada uma mensagem de confirmação:
"<> criado com sucesso. As alterações podem demorar até 10 minutos para entrarem em vigor."
Sem sucesso Se a FedEx receber uma resposta diferente de 200 (OK) ou 202 (Aceite), a validação do URL de destino do webhook será considerada sem sucesso.
CLOSE

Response

Copy