Fedex Logo

CRIAR UM
WEBHOOK GERIR WEBHOOKS

Testar o webhook


Pode utilizar a funcionalidade Testar URL de webhook para testar o tipo de dados de rastreio devolvidos no URL de destino (servidor de destinatário/de escuta). Isto ajuda a validar o URL e os dados devolvidos antes de criar um webhook de Visibilidade integrada avançada.

Navegação:

Seguem-se as formas de navegar para a consola de sandbox Testar URL de webhook:

  • Os meus projetos (no painel de navegação à esquerda) -> separador Visibilidade integrada avançada -> botão Testar URL do webhook ->na Consola de sandbox, clique em Experimentar esta Visibilidade integrada avançada
  • Catálogo de API (no painel de navegação à esquerda) -> pesquise Visibilidade integrada avançada/clique em Visibilidade integrada avançada em FILTROS -> cartão Visibilidade integrada avançada:
    1. -> Descrição geral -> botão Documentação -> na consola de sandbox, clique em Experimentar esta Visibilidade integrada avançada.
    2. -> Documentos -> na consola de sandbox, clique em Experimentar esta Visibilidade integrada avançada.

Passos:

Seguem-se os passos para utilizar a funcionalidade Testar URL de webhook:

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

    URL de destino

    Trata-se do URL para receber os dados do evento de rastreio/da carga.

    • O cliente deve indicar um URL de destino funcional e válido.
    • O URL de destino fornecido tem de estar no formato sintático padrão (URL HTTPS seguro).

    Token de Segurança

    Utilizado como segredo partilhado para autenticar e validar a resposta do webhook de Visibilidade integrada avançada.

    • O valor do token tem de ter um comprimento mínimo de 26 carateres e máximo de 100 carateres.
    • É obrigatório, pelo menos, 1 letra maiúscula, 1 letra minúscula e 1 caráter numérico.
    • O token de segurança será utilizado para criar uma assinatura de código de autenticação de mensagem baseado em hash (HMAC) para validação da resposta.

    Idioma da carga

    Selecione o idioma preferencial da tradução de dados de rastreio a partir da Lista de opções. Seguem-se os 6 idiomas de exemplo disponíveis:

    • Inglês (Estados Unidos)(predefinido)

    Tipo de Rastreio

    Selecione o tipo de resposta na qual os dados de rastreio têm de ser recebidos.

    • Resposta de rastreio detalhado (o tipo de resposta consiste em dados de rastreio seguros com o histórico completo de eventos).(Predefinição)
    • Resposta de rastreio específico do evento (o tipo de resposta consiste em dados de rastreio seguros apenas com as informações mais recentes do evento).(Em breve)

    Rastrear eventos

    Selecione uma categoria de nível superior para receber notificações por e-mail relacionadas com eventos de expedições no ciclo de vida do volume. Seguem-se as categorias de nível superior:

    • Expedir
    • Em Trânsito
    • Entrega
    • Exceções
    • Entrega estimada

    Evento do estado

    Um evento de rastreio no ciclo de vida do volume. Selecione um dos eventos de rastreio a receber. Seguem-se os 10 eventos de estado de exemplo disponíveis:

    1. Recolhido
    2. Em trânsito
    3. Entregue
    4. Exceção de Entrega

     

    Nota: os valores do campo "Evento do estado" serão preenchidos com base na "Categoria do evento de rastreio". Consulte a seguinte tabela para saber mais sobre a "Categoria do evento de rastreio" e os respetivos "Eventos do estado".

     

    Categoria do evento do estado Evento do estado

    Expedir
    • Recolhido

    Em trânsito
    • Em trânsito

    Entrega
    • Entregue

    Exceções
    • Exceção de Entrega

    Entrega estimada(Em breve)
    • Data de entrega estimada (EDD)
    • Intervalo de tempo da entrega estimada (EDTW)

     

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


Resposta :

Seguem-se os parâmetros de resposta no sandbox:

  • Body – o corpo contém os parâmetros de resposta no separador Testar URL de webhook na consola de sandbox.
  • Status – esta secção no separador Resultados do teste indica o estado do pedido processado.

    • Mensagem de sucesso de exemplo:
    Sucesso
    Os detalhes do evento de Rastreio da Visibilidade integrada avançada de teste foram 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

Mensagem de sucesso de exemplo

Se a entrega do evento de teste falhar, o ESTADO será apresentado como Erro no separador Resultados do teste com o respetivo código de erro e mensagem de erro.

Mensagem de erro de exemplo:
Código de erro:<<código de erro>>
A entrega dos detalhes do evento de Rastreio da Visibilidade integrada avançada de teste falhou.

Mensagem de erro de exemplo

Regras de validação:

  • O URL da Visibilidade integrada avançada tem de estar no formato sintático padrão.
  • Todos os campos necessários para testar um URL da Visibilidade integrada avançada não podem estar vazios.
  • Para uma validação com sucesso:
    • A FedEx irá enviar um pedido com o JSON do evento de exemplo.
      • Nota: o URL de destino da Visibilidade integrada avançada deve responder com 200 (OK) como código de estado HTTP à FedEx.
  • Para uma validação sem sucesso/com falhas:
    • Se a FedEx receber qualquer resposta além de 200 (OK), a validação do URL de destino da Visibilidade integrada avançada será considerada sem sucesso.
    • A FedEx irá apresentar o código de erro e a mensagem de erro no separador Resultados do teste.

Calculadora de payload de dados

A Calculadora de payload de dados foi concebida para ajudar os utilizadores a estimar a quantidade de dados gerados pela atividade de webhook. Oferece visibilidade sobre tamanhos de payload diários, contagens de expedições e eventos de rastreio, ajudando os utilizadores a tomarem decisões informadas sobre a utilização de dados e o planeamento da integração.

Utilizar a Calculadora

Os utilizadores podem introduzir os seguintes parâmetros:

  • Número de expedições
  • Eventos por expedição (predefinição: 5)
  • Volume de payload diário (calculado automaticamente)

Com base nestas entradas, a calculadora apresenta dinamicamente:

  •  Eventos de rastreio totais
  •  Payload diária
  •  Tamanho total estimado dos dados

Notas informativas:

  •  O valor predefinido de eventos por expedição é 5. Isto baseia-se numa média de 17 a 18 eventos por expedição e em prazos de entrega típicos de 1 a 7 dias, consoante o tipo de serviço, a transportadora e o destino. Pressupõe-se um tempo médio de entrega de 3 dias. Nota: este valor é editável pelo utilizador.
  •  O Volume de payload diário é calculado da seguinte forma: número de expedições × eventos por expedição (predefinição: 5)
  •  Os utilizadores só precisam de introduzir o Número de expedições e clicar em "CALCULAR" para gerar os resultados. Os outros valores são predefinidos ou calculados automaticamente.

Aviso de isenção de responsabilidade: todos os valores fornecidos pela calculadora são aproximações e destinam-se apenas a fins de planeamento.

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