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 envie, de forma segura, dados de eventos de rastreamento quase em tempo real referentes a remessas vinculadas a números de conta FedEx designados para um URL de destino específico.
Para usar essa funcionalidade, um administrador da FedEx ou um administrador DI precisa criar um projeto do webhook de visibilidade integrada avançada.
Opções de navegação
É possível acessar a página dos webhooks de visibilidade integrada avançada de duas formas:
Opção 1: Meus projetos
- Acesse Meus projetos no painel de navegação esquerdo.
- Clique na guia Webhooks.
Opção 2: Catálogo de APIs
- Acesse o Catálogo de APIs no painel de navegação esquerdo.
- Use a barra de pesquisa para localizar a visibilidade integrada avançada ou selecione essa opção na seção FILTROS.
- No cartão do webhook, escolha uma destas opções:
- Clique em Docs → em seguida, clique em + Gerenciar webhooks
Visualização de um projeto de assinatura da visibilidade integrada avançada por número de rastreamento
1. Configuração e acesso pessoal da FedEx
- Um administrador ou representante FedEx iniciará o processo de configuração.
- O perfil da organização é criado por um administrador designado em nome do cliente CSP.
- O número de uma conta de faturamento estabelecida nos EUA elegível é adicionado ao nível da organização pelo administrador em nome do cliente.
- O administrador realizando essa tarefa precisa ter as permissões necessárias para gerenciar a configuração de organizações.
2. Fluxo de trabalho de visualização da assinatura por número de rastreamento
2.1 Visualizar a assinatura
- Depois de criado por um administrador ou representante da FedEx, o projeto de assinatura da visibilidade integrada avançada por número de rastreamento poderá ser visualizado no painel pelos usuários.
2. Visualizar recursos
- Os usuários podem explorar os recursos disponíveis associados ao projeto da assinatura para entender melhor sua funcionalidade e utilização.
Descrições dos recursos
| Nome do campo | Descrição |
|---|---|
| Comprovante de entrega | Confirma que uma remessa foi entregue com sucesso. Inclui:
|
| Entrega estimada | Informa os dados abaixo para auxiliar no planejamento do destinatário:
|
| Eventos de rastreamento | Permite selecionar uma ou mais categorias de evento para receber notificações:
|
A página Detalhes mostrará 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 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:
|
| 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 | 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 "US" (p. ex., en-US, es-US). |
Processo passo a passo
4. Crie um projeto de assinatura
- Siga os passos da seção anterior ou consulte o Guia de introdução.
5. Gere um token OAuth
- Você precisa de um token OAuth para fazer chamadas de API.
- Use a Authorization API para gerar o token.
- Consulte a documentação da Authorization API no catálogo de APIs para ver as etapas em mais detalhes.
6. Acesse a documentação da API
- No menu de navegação à esquerda, clique em Detalhes do projeto.
- Na guia Chaves de produção, role a página até encontrar a documentação da Advanced Integrated Visibility Tracking Number Subscription API.
Visão geral dos endpoints da API
| Endpoint | Propósito |
|---|---|
| Associação de números de rastreamento | Adicionar ou remover números de rastreamento de uma assinatura de webhook. Esse trabalho é assíncrono. A resposta retorna um ID de trabalho. |
| Detalhes do trabalho do número de rastreamento | Informa detalhes para um ID de trabalho específico, por exemplo, quantos números de rastreamento foram adicionados com sucesso ou ainda estão em processamento. |
| Status do trabalho do número de rastreamento | Retorna um resumo de todos os trabalhos sendo processados no momento. |
Use o token OAuth gerado na etapa 2 com o endpoint de associação de números de rastreamento para adicionar números de rastreamento ao webhook.
Regras de validação
- O nome do webhook deve ser exclusivo.
- O URL de destino precisa estar no formato sintático padronizado.
- Todos os campos obrigatórios precisam ser preenchidos.
- É necessário associar pelo menos um número de conta de envio da FedEx válido.
Resultados da validação
| Status | Detalhes |
|---|---|
| Operação bem-sucedida | Uma mensagem de confirmação é mostrada: "<> foi criado com sucesso. Pode levar até 10 minutos para as alterações entrarem em vigor." |
| Falha | Caso a FedEx receba uma resposta que não seja 200 (OK) ou 202 (Aceita), a validação do URL de destino do webhook será considerada falha. |
