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:
1. Através de Os meus projetos:
- Painel de navegação à esquerda → separador Webhooks → +CRIAR UM PROJETO DE WEBHOOK
2. Através do Catálogo de API:
Painel de navegação à esquerda → Catálogo de API
Pesquise ou filtre por Visibilidade integrada avançada
Escolha:
- 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:
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.
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
O processo de criação envolve quatro passos fundamentais:
Passo 1: ativar a Subscrição baseada em número de conta da Visibilidade integrada avançada
Este passo é gerido por um Administrador FedEx ou Representante da FedEx, a pedido de clientes terceiros.
- Documento MNDA: o Administrador FedEx ou Representante da FedEx irá recolher o Acordo de Não Divulgação Mútuo (MNDA) juntamente com uma lista em massa de números de conta de partes diretas/expedidores.
Nota: são permitidos números de conta duplicados associados a outras organizações durante este carregamento.
- Se aplicável, os Preços personalizados serão ativados ao nível da organização.
Nota: esta funcionalidade não está incluída na experiência de julho.
Passo 2: + crie um projeto
Na página Selecionar produtos:
1. Clique em Visibilidade integrada avançada – Número de conta e depois clique em Seguinte.
2. Selecione as contas de faturação, aceite os termos de pagamento e clique em Seguinte.
É necessário adicionar pelo menos uma conta de faturação.
3. Na página Confirmar os detalhes:
- Analise as informações do projeto.
- Aceite os Termos e Condições.
- Caso se apliquem os Preços personalizados, o documento correspondente será automaticamente apresentado.
4. Após a criação com sucesso, será apresentada uma mensagem de confirmação:
"Adicionou o produto com sucesso a "O Meu Projeto"."
5. Descrição Geral do Projeto – Processo de Ativação da Chave de API
- Na página Descrição geral do projeto, no separador Chaves de API na secção API, o estado de produção da subscrição aparecerá inicialmente como "Desativado".
- Um Administrador ou representante da FedEx poderá ativar o produto mediante pedido.
- Depois de ativado, o separador Chave de produção ficará acessível e o estado da produção será atualizado para "A aguardar confirmação".
- Após a ativação final pelo representante ou administrador da FedEx, o estado da produção será refletido como "Ativado".
Passo 3: descrição geral do projeto – Configurar o webhook
1. Navegue até à página Descrição geral do projeto.
2. Selecione o separador Webhooks.
3. Clique no botão + Configurar Webhooks para iniciar a configuração do webhook, que será redirecionado para o separador Webhooks.
Descrições das funcionalidades
| Nome do Campo | Descrição |
|---|---|
| Prova de Entrega | Confirma que uma expedição foi entregue com sucesso. Inclui:
|
| Entrega estimada | Ajuda os destinatários a planear ao fornecer:
|
| Eventos de rastreio | Permite selecionar uma ou mais categorias de eventos para receber notificações:
|
| Filtragem baseada em eventos | Filtra as respostas do webhook para incluir:
|
2. 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:
|
| Token de Segurança | Um segredo partilhado utilizado para autenticar e validar as respostas do webhook com HMAC. Requisitos:
|
| 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:
|
| 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 válido 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.
