Cómo funciona Advanced Integrated Visibility
El servicio de Advanced Integrated Visibility webhook permite a FedEx enviar actualizaciones de seguimiento seguras y prácticamente en tiempo real a una URL concreta. Estas actualizaciones corresponden a envíos vinculados a uno o varios números de cuenta FedEx. Para usar esta función, primero debe crear un proyecto de Advanced Integrated Visibility webhook.
Cómo acceder a la página de Advanced Integrated Visibility
Puede acceder a la página de configuración de Advanced Integrated Visibility de dos maneras:
Opción 1: desde Mis proyectos
1. Vaya a Mis proyectos en el panel de navegación de la izquierda.
2. Haga clic en la pestaña Webhooks.
3. Elija +CREAR UN PROYECTO DE WEBHOOK.
Opción 2: desde el Catálogo de API
1. Abra el Catálogo de API desde el panel de navegación de la izquierda.
2. Busque Advanced Integrated Visibility.
3. Use el filtro WEBHOOK para encontrar la tarjeta adecuada.
4. En la tarjeta:
- Haga clic en Resumen, luego en Documentación y seleccione +CREAR UN PROYECTO DE WEBHOOK.
- O vaya a DOCS y, a continuación, haga clic en +CREAR UN PROYECTO DE WEBHOOK.
Paso 1: elija el tipo de empresa
Haga clic en +CREAR UN PROYECTO y seleccione el tipo de empresa correspondiente en el menú desplegable:
1. Envía con FedEx y necesita integrar el webhook de FedEx en su sistema.
2. Vende o proporciona una solución de software que utiliza datos de FedEx y no es un Proveedor certificado FedEx Compatible.
3. Es un Proveedor certificado FedEx Compatible.
A continuación, seleccione Suscripción de número de seguimiento de Advanced Integrated Visibility como tipo de suscripción.
Configurar una Suscripción de número de seguimiento de Advanced Integrated Visibility
Puede configurar una Suscripción de número de seguimiento de Advanced Integrated Visibility para recibir actualizaciones de seguimiento seguras y casi en tiempo real de uno o varios números de seguimiento de FedEx. Estas actualizaciones se enviarán a la URL de destino que indique.
Pasos para configurar la suscripción
El proceso consta de cuatro pasos:
1. Configurar el proyecto
2. Introducir los datos del proyecto
3. Confirmar la información y aceptar las condiciones
4. Añadir los números de seguimiento
Instrucciones paso a paso
1. En la página Configurar webhook:
Compruebe el número de cuenta de facturación
Aparecerá el número de cuenta de facturación predeterminada de su organización.
Para cambiarlo:
- Haga clic en AÑADIR CUENTA DE FACTURACIÓN A SU ORGANIZACIÓN (si solo tiene una cuenta); o
- Haga clic en SELECCIONAR OTRA CUENTA DE FACTURACIÓN (si tiene varias cuentas).
Nota: Para consultar los precios, visite la página Resumen de Advanced Integrated Visibility.
2. Seleccionar funciones
- Elija las funciones que necesite
- Haga clic en Siguiente para continuar.
Consejo: Si desea obtener más información sobre alguna función, haga clic en el icono de ayuda (?) que aparece junto a ella.
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 Introducir detalles, introduzca 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 de webhook 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). |
3. En la página Confirmar detalles:
- Revise los detalles de su proyecto de webhook.
- Lea y acepte los Términos y condiciones.
- Haga clic en Crear para finalizar la configuración del proyecto de webhook.
4. Una vez que su solicitud se haya enviado correctamente:
- FedEx creará un nuevo proyecto de webhook.
- Recibirá las claves de producción para la Advanced Integrated Visibility Tracking Number Subscription API.
- Podrá utilizar esta API para vincular números de seguimiento a su proyecto.
Para obtener más información, consulte la página de documentación de la Advanced Integrated Visibility Tracking Number Subscription API.
Cómo añadir un número de seguimiento a un webhook
Para añadir un número de seguimiento a su suscripción de webhook mediante la Advanced Integrated Visibility Tracking Number Subscription API, siga estos pasos:
Instrucciones paso a paso
1. Crear un proyecto de suscripción
Utilice los pasos de la sección anterior o consulte la Guía de inicio.
2. 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.
3. 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 números de seguimiento a una suscripción de webhook o eliminarlos. 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. |
