Cómo funciona la visibilidad integrada avanzada
Descripción general de la webhook de visibilidad integrada avanzada
La webhook de visibilidad integrada avanzada permite a FedEx enviar datos de eventos de rastreo seguros casi en tiempo real a una URL de destino específica para envíos asociados con un número de cuenta FedEx.
Para usar esta función, un administrador FedEx o administrador de DI debe crear un proyecto de webhook de visibilidad integrada avanzada.
Opciones de navegación
Puedes entrar a la página de webhooks de visibilidad integrada avanzada de dos maneras:
Opción 1: A través de Mis proyectos
- Entra a Mis proyectos desde el panel de navegación izquierdo.
- Haz clic en la pestaña Webhooks.
Opción 2: A través del catálogo de API
- Abre el Catálogo de API desde el panel de navegación izquierdo.
- Usa la barra de búsqueda para encontrar la visibilidad integrada avanzada o selecciónala desde la sección FILTROS.
- Elige lo siguiente en la tarjeta de webhook:
- Haz clic en Docs → después haz clic en + Administrar webhooks
Cómo ver un proyecto de suscripción del número de rastreo de la visibilidad integrada avanzada
1. Acceso y configuración personal de FedEx
- Un administrador FedEx o un representante FedEx iniciará el proceso de configuración.
- El perfil de la organización es creado por un administrador designado en nombre de los clientes CSP.
- El administrador, en nombre del cliente, agrega un número de cuenta de facturación elegible, que tengo origen en EE. UU., al nivel de la organización.
- El administrador que realiza esta configuración debe tener los permisos adecuados para gestionar la configuración a nivel organización.
2. Ver el flujo de trabajo para una suscripción del número de rastreo
2.1 Ver la suscripción
- Una vez que un administrador o representante FedEx crea un proyecto, los usuarios pueden ver la visibilidad integrada avanzada asociada, así como el proyecto de suscripción del número de rastreo dentro de su panel de control.
2. Ver las funciones
- Los usuarios pueden explorar las funciones disponibles asociadas a su proyecto de suscripción para su mejor entendimiento y uso.
Descripción de las funciones
| Nombre del campo | Descripción |
|---|---|
| Prueba de la entrega | Confirma que un paquete se entregó con éxito. Incluye:
|
| Entrega estimada | Ayuda al itinerario del recipiente al proporcionar:
|
| Eventos de rastreo | Permite la selección de una o más categorías de evento para recibir notificaciones:
|
En la página Detalles, se muestra la siguiente información:
| Nombre del campo | Descripción |
|---|---|
| Nombre del proyecto de webhook | Un nombre único, que no puede dejarse en blanco, para el proyecto de webhook. El campo se llena automáticamente con un nombre sugerido, pero este puede editarse. Este nombre no debe repetirse en otro webhook. |
| URL de destino | El punto final seguro de HTTPS al que FedEx enviará los datos de los eventos de rastreo. Requisitos:
|
| Token de seguridad | Una clave secreta compartida que se usa para autenticar y validar las respuestas del webhook vía HMAC. Requisitos:
|
| Idioma de carga (país) | Selecciona el idioma de preferencia para las traducciones de datos de rastreo en la lista desplegable. |
| Tipo de rastreo | Elige cómo se entregarán los datos de rastreo:
|
| Dirección de correo electrónico | Proporciona una dirección de correo electrónico válida para recibir notificaciones. |
| Idioma del correo electrónico (país) | Selecciona el idioma preferido para recibir notificaciones por correo electrónico. Nota: solo se admiten idiomas locales de EE. UU. (P. ej. en-US, es-US). |
Proceso paso a paso
4. Crea un proyecto de suscripción
- Usa los pasos de la sección anterior o consulta la Guía de inicio.
5. Genera un token OAuth
- Necesitas un token OAuth para hacer llamadas de la API.
- Usa la API de autorización para generar el token.
- Consulta la documentación de la API de autorización en el catálogo de API para conocer los pasos detallados.
6. Accede a la documentación de la API
- En el menú de navegación de la izquierda, haz clic en Detalles del proyecto.
- En la pestaña Claves de producción, desplázate hacia abajo para encontrar la documentación de la API de la suscripción del número de rastreo de visibilidad integrada avanzada.
Descripción general de los puntos finales de la API
| Punto final | Propósito |
|---|---|
| Asociación de números de rastreo | Agregar o eliminar números de rastreo de una suscripción de webhook. Este es un trabajo asíncrono. La respuesta devolverá un número de identificación del trabajo. |
| Detalles del trabajo del número de rastreo | Proporciona detalles para un número de identificación del trabajo, tal como cuántos números de rastreo se agregaron con éxito o los que siguen procesándose. |
| Estado del trabajo del número de rastreo | Devuelve un resumen de todos los trabajos que se están procesando actualmente. |
Usa el token OAuth del Paso 2 con el punto final de Asociación de número de rastreo para agregar números de rastreo a tu webhook.
Reglas de validación
- Los nombres de la webhook debe ser único.
- La URL de destino debe seguir un formato sintáctico estándar.
- Todos los campos obligatorios deben estar completos.
- Al menos debe asociarse un número de cuenta de envío de FedEx válido.
Resultados de la validación
| Estado | Detalles |
|---|---|
| Con éxito | Se muestra un mensaje de confirmación: «<> se creó con éxito. Los cambios pueden tardar hasta 10 minutos en verse reflejados.» |
| Sin éxito | Si FedEx recibe otra respuesta distinta a 200 (ACEPTAR) o 202 (Aceptado), la validación de la URL de destino del webhook se considerará fallida. |
