Cómo funciona Advanced Integrated Visibility
Resumen del servicio de Advanced Integrated Visibility webhook
El servicio de Advanced Integrated Visibility webhook permite a FedEx enviar información relacionada con eventos de seguimiento de forma segura y prácticamente en tiempo real a una URL de destino concreta para envíos vinculados a uno o varios números de cuenta FedEx.
Para usar esta función, un administrador de FedEx o un administrador de interfaz de datos debe crear un proyecto de Advanced Integrated Visibility webhook.
Opciones de navegación
Puede acceder a la página de Advanced Integrated Visibility Webhooks de dos maneras:
Opción 1: desde Mis proyectos
- Vaya a Mis proyectos en el panel de navegación de la izquierda.
- Haga clic en la pestaña Webhooks.
Opción 2: desde el Catálogo de API
- Abra el Catálogo de API desde el panel de navegación de la izquierda.
- En la barra de búsqueda, busque Advanced Integrated Visibility o selecciónelo en la sección FILTROS.
- En la tarjeta webhook, elija una de las siguientes opciones:
- Haga clic en Docs → y luego en + Gestionar webhooks.
Ver un proyecto de suscripción de número de seguimiento de Advanced Integrated Visibility
1. Acceso y configuración en FedEx
- Un administrador o un representante de FedEx iniciará el proceso de configuración.
- El perfil de la organización lo creará un administrador designado en nombre de los clientes CSP.
- El administrador añadirá un número de cuenta de facturación válido en EE. UU. a nivel de organización en nombre del cliente.
- Este administrador debe tener los permisos necesarios para gestionar la configuración de la organización.
2. Flujo de visualización de la suscripción de número de seguimiento
2.1 Ver la suscripción
- Una vez que el administrador o representante de FedEx crea un proyecto, los usuarios pueden ver el proyecto de suscripción de número de seguimiento de Advanced Integrated Visibility en el panel de control.
2. Ver funciones
- Los usuarios pueden explorar las funciones disponibles asociadas con el proyecto de suscripción para entender mejor cómo utilizarlo.
Descripción de las funciones
| Nombre del campo | Descripción |
|---|---|
| Prueba de entrega | Confirma que el envío se ha entregado correctamente. Incluye:
|
| Entrega estimada | Ayuda a los destinatarios a organizarse, ya que indica lo siguiente:
|
| Eventos de seguimiento | Permite seleccionar una o varias categorías de eventos para recibir notificaciones:
|
En la página de detalles, se mostrará la siguiente información:
| Nombre del campo | Descripción |
|---|---|
| Nombre del proyecto de webhook | Nombre del proyecto de webhook que es único y no está vacío. Se completa automáticamente con una sugerencia que puede editarse, si procede. Este nombre no debe repetirse en ningún otro webhook. |
| URL de destino | Punto de conexión HTTPS seguro al que FedEx enviará los datos de los eventos de seguimiento. Requisitos:
|
| Token de seguridad | Clave secreta compartida utilizada para autenticar y validar las respuestas mediante el HMAC. Requisitos:
|
| Idioma de la carga útil (país) | Seleccione el idioma que desee para las traducciones de los datos de seguimiento en la lista desplegable. |
| Tipo de seguimiento | Elija cómo desea recibir la información de seguimiento:
|
| Dirección de correo electrónico | Indique una dirección de e-mail válida para recibir notificaciones. |
| Idioma del e-mail (país) | Seleccione su idioma preferido para recibir notificaciones por e-mail. Nota: Solo están disponibles configuraciones regionales de EE. UU. (por ejemplo, en-US, es-US). |
Instrucciones paso a paso
4. Crear un proyecto de suscripción
- Utilice los pasos de la sección anterior o consulte la Guía de inicio.
5. Generar un token OAuth
- Necesitará un token OAuth para realizar llamadas a la API.
- Utilice la Authorization API para generar el token.
- Consulte la documentación de la Authorization API en el Catálogo de API para obtener instrucciones detalladas.
6. Acceder a la documentación de la API
- En el menú de navegación de la izquierda, haga clic en Detalles del proyecto.
- En la pestaña Claves de producción, desplácese hasta encontrar la documentación de la Advanced Integrated Visibility Tracking Number Subscription API.
Resumen de los puntos de conexión de API
| Punto de conexión | Finalidad |
|---|---|
| Vinculación de un número de seguimiento | Permite añadir o eliminar números de seguimiento de una suscripción a un webhook. Se trata de un proceso asíncrono. La respuesta devuelve un ID de tarea. |
| Detalles de una tarea de un número de seguimiento | Aporta información detallada de un ID de tarea específico, como la cantidad de números de seguimiento añadidos correctamente o que aún se están procesando. |
| Estado de una tarea de un número de seguimiento | Devuelve un resumen de todas las tareas que se están procesando. |
Utilice el token OAuth del paso 2 con el punto de conexión Vinculación de un número de seguimiento para añadir números de seguimiento a su webhook.
Normas de validación
- El nombre del webhook debe ser único.
- La URL de destino debe ajustarse al formato sintáctico estándar.
- Deben rellenarse todos los campos obligatorios.
- Debe asociarse al menos un número de cuenta de envío FedEx válido.
Resultados de validación
| Estado | Detalles |
|---|---|
| Correcto | Se muestra el siguiente mensaje de confirmación: «<> se ha creado correctamente. Los cambios podrían tardar hasta 10 minutos en aplicarse». |
| Incorrecto | Si FedEx recibe una respuesta que no sea 200 (OK) o 202 (Aceptado), la validación de la URL de destino del webhook se considerará fallida. |
