Como funciona a visibilidade integrada avançada
O webhook da visibilidade integrada avançada permite à FedEx enviar atualizações de rastreamento seguras e quase em tempo real para um URL específico. Essas atualizações se aplicam a remessas vinculadas a um ou mais números de conta FedEx. Para usar esse recurso, você precisa criar um projeto de webhook da visibilidade integrada avançada.
Como acessar a página da visibilidade integrada avançada
É possível acessar a página de configuração dos webhooks de visibilidade integrada avançada de duas formas:
Opção 1: Meus projetos
1. Selecione Meus projetos no painel de navegação esquerdo.
2. Clique na guia Webhooks.
3. Selecione +CRIAR PROJETO DE WEBHOOK.
Opção 2: Catálogo de APIs
1. Abra o Catálogo de APIs no painel de navegação esquerdo.
2. Pesquise a visibilidade integrada avançada.
3. Use o filtro WEBHOOK para encontrar o cartão correto.
4. No cartão:
- Clique em Visão geral, depois no botão Documentação e escolha +CRIAR PROJETO DE WEBHOOK.
- Ou acesse o DOCS e clique em +CRIAR PROJETO DE WEBHOOK.
Etapa 1: selecione o tipo de empresa
Clique em +CRIAR PROJETO e escolha o tipo de empresa no menu suspenso:
1. Faz envios com a FedEx e precisa integrar o webhook da FedEx ao sistema.
2. Vende ou fornece uma solução de software que usa dados da FedEx e não é um fornecedor compatível com a FedEx certificado.
3. É um fornecedor compatível com a FedEx certificado.
Depois, selecione Assinatura da visibilidade integrada avançada por número de rastreamento como o tipo de assinatura.
Criar uma assinatura da visibilidade integrada avançada por número de rastreamento
Você pode configurar uma assinatura da visibilidade integrada avançada por número de rastreamento para receber atualizações de rastreamento, de forma segura e quase em tempo real, referentes a um ou mais números de rastreamento FedEx. Essas atualizações são enviadas para o URL de destino que você especificar.
Etapas para criar a assinatura
Esse processo tem quatro etapas:
1. Configurar projeto
2. Inserir as informações do projeto
3. Confirmar as informações e aceitar os termos
4. Adicionar número de rastreamento
Instruções passo a passo
1. Na página Configurar webhook:
Verifique o número da conta de faturamento
O número da conta de faturamento padrão da sua organização aparecerá.
Se precisar alterá-lo:
- 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: para saber mais sobre os preços, consulte a página do Guia de preços na visão geral da visibilidade integrada avançada.
2. Selecionar recursos
- Escolha os recursos necessários.
- Clique em Próximo para continuar.
Dica: para saber mais sobre cada recurso, clique no ícone de ajuda (?) ao lado dele.
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:
|
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:
|
| 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 dos EUA (por exemplo, en-US, es-US). |
3. Na página Confirmar informações:
- Revise as informações do projeto de webhook.
- Leia e aceite os termos e condições.
- Clique em Criar para finalizar a configuração do projeto de webhook.
4. Quando a solicitação for enviada com sucesso:
- A FedEx criará um projeto de webhook.
- Você receberá as chaves de produção da Advanced Integrated Visibility Tracking Number Subscription API.
- Você pode usar essa API para associar números de rastreamento ao projeto.
Para saber mais, consulte a página de documentação da Advanced Integrated Visibility Tracking Number Subscription API.
Como adicionar um número de rastreamento a um webhook
Para adicionar um número de rastreamento à assinatura de webhook usando a Advanced Integrated Visibility Tracking Number Subscription API, siga estas etapas:
Processo passo a passo
1. Crie um projeto de assinatura
· Siga os passos da seção anterior ou consulte o Guia de introdução.
2. 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.
3. Acesse a documentação da API
- No menu de navegação esquerdo, 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. |
