Visão geral
O webhook de visibilidade integrada avançada permite que a FedEx envie, de forma segura e quase em tempo real, dados de eventos de rastreamento referentes a remessas associadas a um ou mais números de conta FedEx para um URL de destino específico. Você pode criar um projeto de webhook para acessar essa funcionalidade pelo FedEx Developer Portal.
Caminhos de navegação
Você pode acessar a página de criação de webhooks de uma destas formas:
1. No menu Meus projetos:
- Painel de navegação esquerdo → guia Webhooks → +CRIAR PROJETO DE WEBHOOK
2. No catálogo de APIs:
Painel de navegação esquerdo → Catálogo de APIs
Pesquise ou filtre por Visibilidade integrada avançada
Escolha:
- Visão geral → Clique em Documentação → No Console Sandbox, clique em +CRIAR PROJETO
- Docs → Clique em +CRIAR WEBHOOK
Etapas de criação de webhooks
Etapa 1: selecione o tipo de empresa
Clique em +CRIAR PROJETO e escolha o tipo de empresa no menu suspenso:
1. Faz envios com a FedEx e precisa integrar os webhooks da FedEx ao sistema.
2. Vende ou fornece uma solução de software que usa dados da FedEx e não é um fornecedor compatível com a FedEx certificado.
3. É um fornecedor compatível com a FedEx certificado.
Observação: atualmente, a solução de webhook de visibilidade integrada avançada da FedEx não está disponível para essa opção. Como membro do programa de compatibilidade da FedEx, se você quiser acessar a visibilidade integrada básica ou outras soluções de integração da FedEx, entre em contato com o gerente de canal. Se você não sabe quem é o gerente de canal, entre em contato com o administrador da sua empresa.
Depois, selecione Assinatura da visibilidade integrada avançada por número de conta como o tipo de assinatura.
Como criar uma assinatura da visibilidade integrada avançada por número de conta
Há quatro etapas nesse processo:
Etapa 1: ativar a assinatura da visibilidade integrada avançada por número de conta
Essa etapa é gerenciada por um administrador ou representante FedEx, mediante solicitação de clientes terceiros.
- MNDA: o administrador ou representante FedEx coletará o acordo de confidencialidade mútuo (MNDA) e uma lista em massa de número de conta da primeira parte/remetente.
Observação: durante esse envio, são permitidos números de conta duplicados associados a outras organizações.
- Se aplicável, o Preço personalizado será habilitado no nível da organização.
Observação: esse recurso não está incluso na experiência de julho.
Etapa 2: + criar projeto
Na página Selecionar produtos:
1. Clique em Visibilidade integrada avançada – número de conta e, depois, em Próximo.
2. Selecione as contas de faturamento, aceite os termos de pagamento e clique em Próximo.
É necessário adicionar pelo menos uma conta de faturamento.
3. Na página Confirmar informações:
- Revise as informações do projeto.
- Aceite os termos e condições.
- Se o Preço personalizado for aplicável, o documento relacionado aparecerá automaticamente.
4. Quando a criação for bem-sucedida, você verá uma mensagem de confirmação:
"Você adicionou o produto a 'Meu projeto'."
5. Visão geral do projeto – processo de ativação da chave da API
- Na página Visão geral do projeto, na guia Chaves de API da seção APIs, o status de produção da assinatura aparecerá primeiro como "Desativado".
- Um administrador ou representante FedEx poderá ativar o produto mediante solicitação.
- Após a ativação, você poderá acessar a guia Chave de produção, e o status da produção será atualizado para "Aguardando confirmação".
- Após a ativação final pelo administrador ou representante FedEx, o status de produção mudará para "Ativado".
Etapa 3: Visão geral do projeto – configurar o webhook
1. Acesse a página Visão geral do projeto.
2. Selecione a guia Webhooks.
3. Clique no botão + Configurar webhooks para iniciar a configuração. A guia Webhooks aparecerá.
Descrições dos recursos
| Nome do campo | Descrição |
|---|---|
| Comprovante de entrega | Confirma que uma remessa foi entregue. Inclui:
|
| Entrega estimada | Fornece as informações abaixo para auxiliar no planejamento do destinatário:
|
| Eventos de rastreamento | Permite escolher uma ou mais categorias de eventos para o recebimento de notificações:
|
| Filtros com base 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 exclusivo preenchido para o projeto de webhook. Um nome sugerido é inserido automaticamente, mas é possível editá-lo. Não é permitido repetir o nome em outro projeto de webhook. |
| URL de destino | O endpoint HTTPS seguro para onde a FedEx enviará os dados do evento de rastreamento. Requisitos:
|
| Token de segurança | Um segredo compartilhado usado para autenticar e validar a resposta do webhook por HMAC. Requisitos:
|
| Idioma da carga útil (país) | No menu suspenso, selecione o idioma que deseja usar para a tradução dos dados de rastreamento. |
| Tipo de rastreamento | Escolha como os dados de rastreamento devem ser entregues:
|
| Endereço de e-mail | Forneça um endereço de e-mail válido para o recebimento de notificações. |
| Idioma do e-mail (país) | Escolha em que idioma você prefere receber as notificações por e-mail. Observação: compatível apenas com localidades dos EUA (por exemplo, en-US, es-US). |
Etapa 3: escolher contas de envio
Na página Escolher contas de envio:
- Selecione um ou mais números de conta FedEx para associá-los ao seu projeto de webhook.
Observações importantes:
- Somente as contas que ainda não estão associadas a outros webhooks serão exibidas.
- É necessário associar pelo menos uma conta para continuar.
- É possível adicionar até 100 contas pela interface do webhook.
- Para associar mais de 100 contas, use a API de webhook.
Fale com o Suporte ao Cliente FedEx ou com o suporte ao usuário para solicitar acesso à API.
Etapa 4: confirmar informações e criar
Na página Confirmar informações:
1. Revise todas as informações que você inseriu no projeto do webhook.
2. Marque a caixa de seleção para aceitar os termos e condições.
3. Clique em Criar para finalizar a configuração do webhook.
Após o envio bem-sucedido, o webhook será criado com um ID de assinatura gerado pelo sistema e o status ficará Ativo.
Regras de validação
Requisitos gerais:
- O nome do webhook precisa ser exclusivo.
- O URL de destino precisa seguir um formato sintático padronizado (HTTPS seguro, sem incluir fedex.com ou seus subdomínios).
- É preciso preencher todos os campos obrigatórios. Nenhum campo obrigatório pode ficar em branco.
- É necessário associar pelo menos um número de conta de envio da FedEx válido.
Validação bem-sucedida:
Quando um webhook for criado, o cliente receberá uma mensagem de confirmação:
O webhook <<Nome do webhook>> foi criado. As alterações podem levar até 10 minutos para entrar em vigor.
Validação malsucedida/com falha:
Caso a FedEx receba uma resposta que não seja HTTP 200 (OK) ou 202 (Aceita) do URL de destino, a validação do webhook será considerada com falha.
