Como funciona a Visibilidade integrada avançada
Visão geral do webhook de Visibilidade integrada avançada
O webhook de Visibilidade integrada avançada permite que a FedEx emita, com segurança, dados de eventos de rastreio praticamente em tempo real para um URL de destino especificado referente a expedições associadas aos números de conta FedEx designados.
Para utilizar esta funcionalidade, um Administrador FedEx ou Administrador de DI tem de criar um projeto de webhook de Visibilidade integrada avançada.
Opções de navegação
É possível aceder à página webhooks de Visibilidade integrada avançada de duas formas:
Opção 1: através de Os meus projetos
- Navegue até Os meus projetos no painel de navegação à esquerda.
- Clique no separador Webhooks.
Opção 2: através do Catálogo de API
- Aceda ao Catálogo de API no painel de navegação à esquerda.
- Utilize a barra de pesquisa para encontrar a Visibilidade integrada avançada ou selecione-a na secção FILTROS.
- No Cartão de webhook, selecione uma das seguintes opções:
- Clique em Documentos → e, em seguida, clique em + Gerir webhooks
Visualização de um projeto de Subscrição baseada em número de rastreio da Visibilidade integrada avançada
1. Acesso e configuração pessoal da FedEx
- Um Administrador FedEx ou Representante da FedEx iniciará o processo de configuração.
- O perfil da organização é criado por um administrador designado em nome de clientes CSP.
- Um número de conta de faturação elegível localizado nos EUA é adicionado ao nível da organização pelo administrador em nome do cliente.
- O administrador que está a efetuar esta configuração tem de ter as permissões adequadas para gerir configurações ao nível da organização.
2. Ver o fluxo de trabalho para a Subscrição baseada em número de rastreio
2.1 Ver a Subscrição
- Quando um Administrador ou Representante da FedEx cria um projeto, os utilizadores podem visualizar o Projeto de Visibilidade integrada avançada – Subscrição baseada em número de rastreio no respetivo painel de controlo.
2. Ver funcionalidades
- Os utilizadores podem explorar as funcionalidades disponíveis associadas ao projeto de subscrição para uma melhor compreensão e utilização.
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:
|
Na página Detalhes, serão apresentadas 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). |
Processo passo a passo
4. Criar um Projeto de subscrição
- Utilize os passos da secção anterior ou consulte o Guia de introdução.
5. Gerar um token OAuth
- Precisa de um token OAuth para fazer chamadas à API.
- Utilize a Authorization API para gerar o token.
- Consulte a documentação da Authorization API no Catálogo de API para obter passos detalhados.
6. Aceder à documentação da API
- No menu de navegação esquerdo, clique em Detalhes do projeto.
- No separador Chaves de produção, navegue para baixo para encontrar a documentação da Tracking Number Subscription API da Visibilidade integrada avançada.
Descrição geral dos pontos finais da API
| Ponto final | Finalidade |
|---|---|
| Associação do número de rastreio | Adicione ou remova números de rastreio de uma subscrição de webhook. Trata-se de uma tarefa assíncrona. Um ID da tarefa é devolvido na resposta. |
| Detalhes da tarefa do número de rastreio | Fornece detalhes para um ID da tarefa específico, por exemplo, quantos números de rastreio foram adicionados com sucesso ou ainda estão a ser processados. |
| Estado da tarefa do número de rastreio | Devolve um resumo de todas as tarefas a ser processadas atualmente. |
Utilize o token OAuth do Passo 2 com o ponto final Associação de números de rastreio para adicionar números de rastreio ao seu webhook.
Regras de validação
- Os nomes de webhooks têm de ser únicos.
- O URL de destino tem de seguir um formato sintático padrão.
- Todos os campos obrigatórios têm de ser preenchidos.
- É obrigatório associar, pelo menos, um número de conta de expedição FedEx válido.
Resultados da validação
| Estado | Detalhes |
|---|---|
| Com sucesso | É apresentada uma mensagem de confirmação: "<> criado com sucesso. As alterações podem demorar até 10 minutos para entrarem em vigor." |
| Sem sucesso | Se a FedEx receber uma resposta diferente de 200 (OK) ou 202 (Aceite), a validação do URL de destino do webhook será considerada falhada. |
