Cómo funciona la visibilidad integrada avanzada
La webhook de visibilidad integrada avanzada permite que FedEx envíe actualizaciones de rastreo seguras, casi en tiempo real, a una URL específica. Estas actualizaciones son para los envíos vinculados a uno o más números de cuenta FedEx. Para usar esta función, debes crear un proyecto de webhook de visibilidad integrada avanzada.
Cómo ingresar a la página de visibilidad integrada avanzada
Puedes entrar a la configuración de visibilidad integrada avanzada de dos maneras:
Opción 1: A través de Mis proyectos
1. Entra a Mis proyectos en el panel de navegación izquierdo.
2. Haz clic en la pestaña Webhooks.
3. Selecciona +CREAR UN PROYECTO DE WEBHOOK.
Opción 2: A través del catálogo de API
1. Abre el Catálogo de API desde el panel de navegación izquierdo.
2. Busca una visibilidad integrada avanzada.
3. Usa el filtro WEBHOOK para encontrar la tarjeta correcta.
4. En la tarjeta:
- Haz clic en Descripción general, después en el botón Documentación y elige +CREAR UN PROYECTO DE WEBHOOK.
- O ve a DOCS y haz clic en +CREAR UN PROYECTO DE WEBHOOK.
Paso 1: Selecciona el tipo de compañía
Haz clic en +CREAR UN PROYECTO y elige tu tipo de compañía en la lista desplegable:
1. Haces envíos con FedEx y necesitas integrar webhook de FedEx a tu sistema.
2. Vendes o proporcionas una solución de programa informático que usa datos de FedEx y no es un proveedor de soluciones FedEx compatible certificado.
3. Es un proveedor de soluciones FedEx compatible certificado.
Después, selecciona suscripción de números de rastreo para la visibilidad integrada avanzada como tu tipo de suscripción.
Crea una suscripción del número de rastreo de visibilidad integrada avanzada
Puedes configurar una suscripción del número de rastreo de visibilidad integrada avanzada para recibir actualizaciones de rastreo seguras, casi en tiempo real, para uno o más números de rastreo de FedEx. Estas actualizaciones se envían a una URL de destino que especifiques.
Pasos para crear la suscripción
Este proceso consta de cuatro pasos principales:
1. Configurar el proyecto
2. Ingresar los detalles del proyecto
3. Confirmar los detalles y aceptar los términos
4. Agregar los números de rastreo
Instrucciones paso a paso
1. En la página Configurar webhook:
Selecciona el número de cuenta de facturación
Se mostrará el número de cuenta de facturación predeterminado de tu organización.
Para cambiarlo:
- Haz clic en AGREGAR CUENTA DE FACTURACIÓN A TU ORGANIZACIÓN (si solo existe una cuenta); o
- Haz clic en SELECCIONAR OTRA CUENTA DE FACTURACIÓN (si existen múltiples cuentas).
Nota: Para obtener más información sobre los precios, consulta la página de descripción general de la visibilidad integrada avanzada.
2. Seleccionar funciones
- Elige las funciones que necesitas.
- Haz clic en Siguiente para continuar.
Consejo: Para saber más sobre las funciones, haz clic en el ícono de ayuda (?) junto a la función.
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:
|
Proporciona la siguiente información en la página Ingresar detalles:
| 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). |
3. En la página Confirmar detalles:
- Revisa los detalles de tu proyecto de webhook.
- Selecciona y acepta los Términos y condiciones.
- Haz clic en Crear para finalizar la configuración del proyecto de webhook.
4. Una vez que tu solicitud se haya enviado con éxito:
- FedEx creará un nuevo Proyecto de webhook.
- Recibirás las claves de producción para la API de la suscripción del número de rastreo de visibilidad integrada avanzada.
- Puedes usar esta API para asociar los números de rastreo a tu proyecto.
Para obtener más información, consulta la página de documentación de la API de la suscripción del número de rastreo de visibilidad integrada avanzada.
Cómo agregar un número de rastreo a un webhook
Para agregar un número de rastreo a tu webhook de suscripción utilizando la API de la suscripción del número de rastreo de visibilidad integrada avanzada, sigue estos pasos:
Proceso paso a paso
1. Crea un proyecto de suscripción
· Usa los pasos de la sección anterior o consulta la Guía de inicio.
2. 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.
3. 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
- El nombre 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. |
