Configuração do webhook de visibilidade integrada avançada
Visão geral
O webhook de visibilidade integrada avançada permite que a FedEx envie dados de eventos de rastreamento, de forma segura e quase em tempo real, 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 do webhook das seguintes formas:
- No menu Meus projetos: painel de navegação esquerdo → guia Webhooks → +CRIAR UM PROJETO DE WEBHOOK
No catálogo de APIs:
- Painel de navegação esquerdo → catálogo de APIs
- Pesquise ou filtre por Visibilidade integrada avançada
- Visão geral → clique em Documentação → no Console Sandbox, clique em +CRIAR PROJETO
- Docs → Clique em +CRIAR WEBHOOK
Etapas de criação do webhook
Etapa 1: selecione o tipo de empresa
Clique em +CRIAR PROJETO e escolha o tipo de empresa no menu suspenso:
- Faz envios com a FedEx e precisa integrar o webhook da FedEx ao sistema.
- Vende ou fornece uma solução de software que usa dados da FedEx e não é um fornecedor compatível com a FedEx certificado.
- É 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
Esse processo tem quatro etapas:
- Configurar projeto
- Inserir as informações do projeto
- Escolher as contas de envio
- Confirmar as informações e aceitar os termos
Etapa 1: configurar o projeto
Na página Configurar webhook:
- Número da conta de faturamento:
- Verifique a conta de faturamento padrão.
- Se precisar alterá-la:
- Clique em ADICIONAR CONTA DE FATURAMENTO À SUA ORGANIZAÇÃO se houver apenas uma conta ou
- Clique em SELECIONAR OUTRA CONTA DE FATURAMENTO caso existam várias contas.
Observação: é necessário ter uma conta de faturamento estabelecida nos EUA. Para saber mais sobre os preços, consulte o Guia de preços na visão geral da visibilidade integrada avançada.
Seleção de recursos:
- Escolha os recursos que você quer ativar e clique em Próximo.
Descrições dos recursos
| Nome do campo | Descrição |
|---|---|
| Comprovante de entrega | Confirma que uma remessa foi entregue com sucesso. Foto do comprovante de entrega (PPODA): fornece uma foto mostrando o local exato da entrega. Comprovante de entrega assinado (SPOD): fornece uma imagem da assinatura do destinatário, bem como seu nome, data, hora e local de entrega. |
| Entrega estimada | Informa os dados abaixo para auxiliar no planejamento do destinatário: Data estimada da entrega (EDD) Janela de tempo de entrega estimada (EDTW) |
| Eventos de rastreamento | Permite selecionar uma ou mais categorias de evento para receber notificações: Enviar Em trânsito Entrega Exceções Opções de entrega personalizada |
| Filtros com base em evento | Filtra as respostas do webhook para incluir: Remessas de entrada Remessas de saída Remessas de terceiros |
Na página Inserir detalhes, informe os seguintes dados:
| 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 pode ser editado. O nome não pode ser repetido em outro projeto de webhook. |
| URL de destino | O endpoint HTTPS seguro para onde a FedEx enviará os dados do evento de rastreamento. Requisitos: Deve ser válido e estar funcionando Deve seguir a sintaxe padronizada Não pode incluir fedex.com nem seus subdomínios Pode ser reutilizado em vários webhooks Consulte a seção Regras comerciais e práticas recomendadas para saber mais. |
| Token de segurança | Um segredo compartilhado usado para autenticar e validar a resposta do webhook por HMAC. Requisitos: Precisa ter entre 26 e 100 caracteres Precisa incluir no mínimo 1 letra maiúscula, 1 letra minúscula e 1 caractere numérico Pode ser reutilizado em vários webhooks |
| 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: Rastreamento detalhado: histórico completo dos eventos Rastreamento de eventos específicos: somente o evento mais recente |
| Endereço de e-mail | Informe um endereço de e-mail válido para o recebimento de notificações. |
| Idioma do e-mail (país) | Escolha o idioma em que 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 as contas de envio
Na página Escolher contas de envio:
- Selecione um ou mais números de conta FedEx para associar 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 as informações e criar
Na página Confirmar detalhes:
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 deve ser exclusivo.
- O URL de destino deve seguir um formato sintático padronizado (HTTPS seguro, sem incluir fedex.com ou seus subdomínios).
- Todos os campos obrigatórios devem ser preenchidos. Nenhum campo obrigatório pode ser deixado em branco.
- É necessário associar pelo menos um número válido de conta de envio da FedEx ao webhook.
Validação bem-sucedida:
Quando um webhook for criado com sucesso, o cliente receberá uma mensagem de confirmação:
O webhook <<Nome do webhook>> foi criado com sucesso. Pode levar até 10 minutos para as alterações entrarem 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.
