Configuração do webhook de Visibilidade integrada avançada
Descrição Geral
O webhook de Visibilidade integrada avançada permite que a FedEx emita dados de eventos de rastreio seguros praticamente em tempo real para um URL de destino especificado referente a expedições associadas a um ou mais Números de conta FedEx. Pode criar um projeto de webhook para aceder a esta funcionalidade através do FedEx Developer Portal.
Caminhos de navegação
Pode aceder à página de criação de webhooks através de uma das seguintes opções:
- Através de Os meus projetos: painel de navegação à esquerda → separador Webhooks → +CRIAR um PROJETO de webhook
Através do Catálogo de API:
- Painel de navegação à esquerda → Catálogo de API
- Pesquise ou filtre por Visibilidade integrada avançada
- Descrição geral → Clique em Documentação → Na consola de sandbox, clique em +CRIAR UM PROJETO
- Documentos → Clique em +CRIAR UM WEBHOOK
Passos para a criação de webhooks
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:
- Envia com a FedEx e tem de integrar o webhook FedEx no seu sistema.
- Comercializa ou fornece uma solução de software que utiliza dados da FedEx e não é um Fornecedor compatível FedEx certificado.
- É um Fornecedor compatível FedEx certificado.
Nota: atualmente, a solução webhook de Visibilidade integrada avançada da FedEx não está disponível para esta opção. Enquanto membro do Programa de compatibilidade FedEx, se quiser aceder à Visibilidade integrada básica ou a outras soluções de integração FedEx, entre em contacto com o seu gestor de canais. Se não souber quem é o gestor de canais, contacte o administrador da empresa.
Em seguida, selecione Subscrição baseada em número de conta da Visibilidade integrada avançada como o seu tipo de subscrição.
Criação de uma Subscrição baseada em número de conta da Visibilidade integrada avançada
Este processo envolve quatro passos principais:
- Configurar Projeto
- Introduza os detalhes do projeto
- Selecionar contas de expedição
- Confirmar os detalhes e aceitar os termos
Passo 1: configurar o projeto
Na página Configurar o webhook:
- Número da conta de faturação:
- Reveja a conta de faturação predefinida.
- Para alterar:
- Clique em ADICIONAR CONTA DE FATURAÇÃO À SUA ORGANIZAÇÃO (se existir apenas uma conta) ou
- Clique em SELECIONAR OUTRA CONTA DE FATURAÇÃO (se existirem várias contas).
Nota: é necessária uma conta de faturação localizada nos EUA. Para detalhes de preços, consulte o Guia de preços de descrição geral da Visibilidade integrada avançada.
Seleção de funcionalidades:
- Selecione as funcionalidades que pretende ativar e, em seguida, clique em Seguinte.
Descrições das funcionalidades
| Nome do Campo | Descrição |
|---|---|
| Prova de Entrega | Confirma que uma expedição foi entregue com sucesso. 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) Período estimado da entrega (EDTW) |
| Eventos de rastreio | Permite a seleção de uma ou mais categorias de eventos para receber notificações: Envios Em trânsito Entrega Exceções Opções de entrega personalizada |
| Filtragem baseada em eventos | Filtra respostas do webhook para incluir: Expedições de importação Expedições internacionais Expedições de terceiros |
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 ser válido e funcionar Tem de seguir uma sintaxe padronizada Não pode incluir fedex.com nem os seus subdomínios Pode ser reutilizado em vários webhooks Consulte a secção de Regras empresariais e boas práticas para mais detalhes. |
| Token de Segurança | Um segredo partilhado utilizado para autenticar e validar as respostas do webhook com HMAC. Requisitos: 26–100 carateres Tem de incluir pelo menos 1 letra maiúscula, 1 letra minúscula e 1 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 como os dados de rastreio devem ser entregues: Rastreio detalhado – Histórico completo de eventos Rastreio específico de eventos – 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). |
Passo 3: selecionar contas de expedição
Na página Selecionar contas de expedição:
- Selecione um ou mais números de conta FedEx para associar ao seu projeto de webhook.
Notas Importantes:
- Apenas as contas que ainda não estão associadas a outros webhooks serão apresentadas.
- Precisa de associar pelo menos uma conta para continuar.
- É possível adicionar um máximo de 100 contas através da IU do webhook.
- Para associar mais de 100 contas, utilize a API de webhooks.
Contacte o Apoio ao cliente FedEx ou o Centro de assistência para pedir acesso à API.
Passo 4: confirmar os detalhes e criar
Na página Confirmar os detalhes:
1. Reveja todas as informações que introduziu para o projeto de webhook.
2. Marque a caixa para aceitar os termos e condições.
3. Clique em Criar para concluir a configuração do webhook.
Após o envio com sucesso, o webhook será criado com um ID de subscrição gerado pelo sistema e será definido como Ativo.
Regras de validação
Requisitos gerais:
- O nome do Webhook tem de ser único.
- O URL de destino tem de seguir um formato sintático padronizado (URL HTTPS seguro, não incluir fedex.com ou os respetivos subdomínios).
- Todos os campos obrigatórios têm de ser preenchidos. Nenhum campo obrigatório deve ficar vazio.
- É obrigatório associar pelo menos um número de conta de expedição FedEx ao webhook.
Validação com sucesso:
Se o webhook for criado com sucesso, o cliente irá receber uma mensagem de confirmação:
<<Webhook name>> criado com sucesso. As alterações podem demorar até 10 minutos para entrarem em vigor.
Validação sem sucesso/falhada:
Se a FedEx receber qualquer resposta diferente de HTTP 200 (OK) ou 202 (Aceite) do URL de destino, a validação do webhook será considerada falhada.
