Descripción general
El 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. Ahora puedes crear un proyecto de webhook para ingresar a esta función a través del FedEx Developer Portal.
Rutas de navegación
Puedes ingresar a la página de creación de webhook por medio de las siguientes opciones:
1. A través de Mis proyectos:
- Panel de navegación izquierdo → pestaña Webhooks → +CREAR UN PROYECTO DE Webhook
2. A través del catálogo de API:
Panel de navegación izquierdo → Catálogo de API
Busca o filtra por Visibilidad integrada avanzada
Elige:
- Vista general → haz clic en Documentación → En la consola Sandbox, haz clic en +CREAR UN PROYECTO
- Docs → haz clic en +CREAR UN Webhook
Pasos para crear una 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. Hace envíos con FedEx y necesita integrar webhook de FedEx a su sistema.
2. Vende o proporciona una solución de software que usa datos de FedEx y no es un proveedor de soluciones FedEx Compatible certificado.
3. Es un proveedor de soluciones FedEx compatible certificado.
Nota: Actualmente, la solución de webhook de visibilidad integrada avanzada de FedEx no está disponible para esta opción. Como miembro del programa de FedEx Compatible, si deseas acceder a la visibilidad integrada básica u otras soluciones de integración de FedEx, comunícate con tu gerente de canal. Si no sabes quién es tu gerente de canal, comunícate con el administrador de tu compañía.
Después, selecciona suscripción de números de cuenta para la visibilidad integrada avanzada como tu tipo de suscripción.
Cómo crear una suscripción de número de cuenta para la visibilidad integrada avanzada
Este proceso consta de cuatro pasos principales:
Paso 1: Habilita la suscripción del número de cuenta de visibilidad integrada avanzada
Este paso está gestionado por un administrador FedEx o un representante FedEx bajo solicitud de clientes externos.
- Documento MNDA: El administrador FedEx o el representante FedEx recolectará el Acuerdo de confidencialidad mutua (MNDA) junto con una lista de los números de cuenta del remitente o primera parte.
Nota: Los números de cuenta duplicados asociados a otras organizaciones están permitidos durante esta carga.
- Si corresponde, se activará el precio personalizado a nivel organizacional.
Nota: Esta funcionalidad no está incluida en la experiencia de julio.
Paso 2: + Crea un proyecto
En la página Seleccionar productos:
1. Haz clic en visibilidad integrada avanzada: número de cuenta y luego haz clic en Siguiente.
2. Selecciona las cuentas de facturación, acepta los términos de pago y haz clic en Siguiente.
Al menos se debe agregar una cuenta de facturación.
3. En la página Confirmar detalles:
- Revisa la información del proyecto.
- Acepta los Términos y condiciones.
- Si se aplica el precio personalizado, el documento relacionado aparecerá automáticamente.
4. Aparecerá un mensaje de confirmación después de una creación exitosa:
«Agregaste correctamente el producto a Mi Proyecto».
5. Descripción general del proyecto: proceso de activación de clave de API
- En la página Descripción general del proyecto, en la pestaña Claves de API en la sección API, el estado de producción de la suscripción aparecerá inicialmente como «Deshabilitada».
- Un administrador o representante FedEx habilitará el producto bajo solicitud.
- Una vez habilitado, se podrá acceder a la pestaña Clave de producción y el estado de producción se actualizará a «En espera de confirmación.»
- Después de la activación final por parte del administrador o representante FedEx, el estado de producción aparecerá como «Habilitado.»
Paso 3: Descripción general del proyecto - Configurar webhook
1. Ve a la página Descripción general del proyecto.
2. Selecciona la pestaña Webhooks.
3. Haz clic en el botón + Configurar Webhooks para comenzar la configuración de webhook. Se te redirigirá a la pestaña Webhooks.
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:
|
| Filtro basado en eventos | Filtra las respuestas de webhook para incluir:
|
2. 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). |
Paso 3: Elige cuentas de envío
En la página Escoge las cuentas de envío:
- Selecciona uno o más números de cuenta FedEx para asociar con tu proyecto de webhook.
Notas importantes:
- Solo se mostrarán las cuentas que no estén asociadas con ningún otro webhook.
- Debes asociar al menos una cuenta para continuar.
- Se pueden agregar un máximo de 100 cuentas usando la UI de webhook.
- Para asociar más de 100 cuentas usa la API de webhooks.
Comunícate con servicio de atención al cliente FedEx o a servicio de apoyo para solicitar acceso a la API.
Paso 4: Confirma los detalles y crea
En la página Confirmar detalles:
1. Revisa toda la información que ingresaste para el proyecto de webhook.
2. Selecciona la casilla para aceptar los términos y condiciones.
3. Haz clic en Crear para finalizar la configuración de webhook.
Después de enviarla correctamente, la webhook se creará con una identificación de suscripción generada por el sistema y se configurará con el estado Activo.
Reglas de validación
Requisitos generales:
- El nombre del Webhook debe ser único.
- La URL de destino debe seguir un formato de sintaxis estandarizado (HTTPS seguro, que no sea fedex.com ni sus subdominios).
- Se deben completar todos los campos obligatorios. Los campos que no son obligatorios deben dejarse en blanco.
- Se debe asociar al menos un número de cuenta de envío de FedEx válido al webhook.
Validación exitosa:
Cuando una webhook se crea exitosamente, el cliente recibirá un mensaje de confirmación.
<<Nombre de la webhook>> se creó con éxito. Los cambios pueden tardar hasta 10 minutos en verse reflejados.
Validación fallida:
Si FedEx recibe otra respuesta distinta a HTTP 200 (ACEPTAR) o 202 (Aceptado), la validación de la URL de destino del webhook se considerará fallida.
