Fedex Logo

CRIAR
WEBHOOK GERENCIAR WEBHOOKS

Testar webhook


Você pode usar o recurso Testar URL do webhook para testar o tipo de dado de rastreamento que retorna ao URL de destino (servidor destinatário/ouvinte). Isso ajuda a validar o URL e os dados de retorno antes da criação de um webhook de visibilidade integrada avançada.

Navegação:

Estas são as formas de acessar o Console Sandbox Testar URL de webhook:

  • Meus projetos (no painel de navegação esquerdo) -> guia Visibilidade integrada avançada -> botão Testar URL do webhook . No Console Sandbox, clique em Testar esta visibilidade integrada avançada
  • Catálogo de APIs (no painel de navegação esquerdo) -> pesquise pela visibilidade integrada avançada ou clique na visibilidade integrada avançada em FILTROS -> cartão da visibilidade integrada avançada:
    1. -> Visão geral -> botão Documentação -> no Console Sandbox, clique em Testar esta visibilidade integrada avançada.
    2. Docs -> no Console Sandbox, clique em Testar esta visibilidade integrada avançada.

Etapas:

Estas são as etapas para usar a funcionalidade Testar URL de webhook:

  1. Clique no botão Testar URL de webhook.
  2. Insira os seguintes parâmetros de teste:
    Nome do campo Descrição

    URL de destino

    É o URL destinado a receber os dados ou a carga útil do evento de rastreamento.

    • O cliente deve informar um URL de destino válido e funcional.
    • O URL de destino informado deve estar no formato sintático padronizado (URL https seguro).

    Token de segurança

    Usado como segredo compartilhado para autenticar e validar a resposta do webhook de visibilidade integrada avançada.

    • O valor do token precisa ter no mínimo 26 e no máximo 100 caracteres.
    • Deve conter pelo menos uma letra maiúscula, uma letra minúscula e um número.
    • O token de segurança será usado para criar uma assinatura de código de autenticação de mensagem baseada em hash (HMAC) para validação de resposta.

    Idioma de carga útil

    Selecione o idioma que deseja usar para a tradução de dados de rastreamento no menu suspenso. Estes são os seis idiomas disponíveis:

    • Inglês (Estados Unidos)(Padrão)

    Tipo de rastreamento

    Selecione o tipo de resposta em que os dados de rastreamento precisam ser recebidos.

    • Resposta de rastreamento detalhado: tipo de resposta que consiste em dados de rastreamento protegidos com todo o histórico de eventos.(Padrão)
    • Resposta de rastreamento específico do evento: tipo de resposta que consiste em dados de rastreamento protegidos com apenas as informações mais recentes do evento.(Em breve)

    Eventos de rastreamento

    Selecione uma categoria de nível superior para receber notificações por e-mail relacionadas a eventos de remessa no ciclo de vida do pacote. Estas são as categorias de nível superior:

    • Enviar
    • Em trânsito
    • Entrega
    • Exceções
    • Entrega estimada

    Evento de status

    Um evento de rastreamento no ciclo de vida do pacote. Selecione um dos eventos de rastreamento a ser recebido. Estes são os 10 eventos de status disponíveis:

    1. Coletado
    2. Em trânsito
    3. Entregue
    4. Exceção de entrega

     

    Observação: os valores do campo "Evento de status" serão preenchidos com base na "Categoria de evento de rastreamento" selecionada. Consulte a tabela a seguir para saber mais sobre a categoria de evento de rastreamento e seus respectivos eventos de status.

     

    Categoria de evento de status Evento de status

    Enviar
    • Coletado

    Em trânsito
    • Em trânsito

    Entrega
    • Entregue

    Exceções
    • Exceção de entrega

    Entrega estimada(em breve)
    • Data estimada da entrega (EDD)
    • Janela de tempo de entrega estimada (EDTW)

     

  3. Marque a caixa Contrato de licença do FedEx Developer Portal (FDPLA) para assinar e aceitar o contrato de licença.
  4. Clique no botão PUSH para visualizar os resultados do teste.


Resposta:

Os parâmetros de resposta no Sandbox são:

  • Corpo – O corpo contém os parâmetros de resposta na guia Testar URL de webhook no Console Sandbox.
  • Status – Seção na guia Resultados do teste que informa o status da solicitação que é processada.

    • Exemplo de mensagem de sucesso:
    Sucesso
    Detalhes do evento de rastreamento de visibilidade integrada avançada de teste entregues com sucesso.

 

Sandbox Console

Test Parameters

Add in test parameters and push to check if the URL receives test event data from Webhooks API calls.

The destination URL is where we will send you authentication codes and messages as well as Advanced Integrated Visibility payload notifications. Only HTTPS connections using TLS (SSL) 1.2 or higher protocol version that is configured with a certificate from a valid certificate authority is supported. (Character limit: 200)

The following are not valid destination URLs:
• All RFC1918 IP space<br>
• All fedex.com and its sub domain<br>
• IP addresses in the URL (including localhost, 127.0.0.1)

Security Token should be a minimum length of 25 characters and a maximum length of 100 characters, 1 upper case, 1 lower case, 1 numeric character.

Example: Y1F6OiVUQW2JPSElmRE9U0IY5

Payload languageThe language in which you will receive the tracking data. Currently payload language is only available in English
View a full list of languages

Currently detailed tracking is the only available tracking type.

Detailed Tracking
Detailed Tracking Response consists of secured data with the entire history of events.

Event-specific Tracking (coming soon)
Event-specific Tracking Response consists of secure tracking data with only the most recent event information.

Tracking event
These are different categories of tracking events in the shipment life cycle. select one or more of these categories. Then when an event in that category happens, we will trigger webhook notifications and send you a tracking payload response.

Select a tracking event in the package lifecycle to include

Copy copied

Status

Success

Test webhook tracking event details delivered successfully

Error

Test webhook tracking event details delivery failed

Exemplo de mensagem de sucesso

Se a entrega do evento de teste falhar, o STATUS será exibido como Erro na guia Resultados do teste com o respectivo código de erro e mensagem de erro.

Exemplo de mensagem de erro:
Código de erro:<<código de erro>>
Falha na entrega dos detalhes do evento de rastreamento da visibilidade integrada avançada de teste.

Exemplo de mensagem de erro

Regras de validação:

  • O URL da visibilidade integrada avançada deve estar no formato sintático padronizado.
  • Todos os campos obrigatórios para testar um URL de visibilidade integrada avançada devem estar preenchidos.
  • Para uma validação bem-sucedida:
    • A FedEx enviará uma solicitação com uma amostra de evento JSON.
      • Observação: o URL de destino da visibilidade integrada avançada precisa retornar o código de status HTTP 200 (OK) para a FedEx.
  • Para uma validação malsucedida/com falha:
    • Caso a FedEx receba uma resposta que não seja 200 (OK), a validação do URL de destino da visibilidade integrada avançada será considerada falha.
    • A FedEx exibirá o código de erro e a mensagem de erro na guia Resultados do teste.

Calculadora de carga útil de dados

A Calculadora de carga útil de dados foi criada para ajudar os inscritos a estimar o volume de dados gerados pela atividade dos webhooks. Ela oferece visibilidade dos tamanhos diários de carga útil, contagens de remessas e eventos de rastreamento, ajudando os usuários a tomar decisões informadas sobre uso de dados e planejamento de integrações.

Como usar a calculadora

Os usuários podem inserir os seguintes parâmetros:

  • quantidade de remessas
  • eventos por remessa (padrão: 5)
  • volume diário da carga útil (calculado automaticamente)

Com base nessas informações, a calculadora exibe, de forma dinâmica:

  •  o total de eventos de rastreamento
  •  a carga útil diária
  •  o tamanho total estimado dos dados

Observações:

  •  O valor padrão de Eventos por remessa é 5, baseado em uma média de 17 ou 18 eventos por remessa e prazos de entrega típicos de 1 a 7 dias, dependendo do tipo de serviço, da transportadora e do destino. Considera-se um tempo médio de entrega de 3 dias. Observação: o usuário pode editar esse valor.
  •  O Volume diário de carga útil é calculado da seguinte forma: quantidade de remessas × eventos por remessa (o valor padrão é 5)
  •  Os usuários precisam apenas inserir a quantidade de remessas e clicar em "CALCULAR" para gerar os resultados. Os demais valores são preenchidos por padrão ou calculados automaticamente.

Isenção de responsabilidade: todos os valores fornecidos pela calculadora são valores aproximados e destinam-se apenas a fins de planejamento.

Number of Shipments
Events per Shipment (default 5)
Daily Payload Volume (events per day)



Note: Displayed values are approximations and may not reflect exact usage metrics.
CLOSE

Response

Copy