Getting started
El FedEx Developer Portal ofrece un conjunto de interfaces de programación de la aplicación (API) para integrar FedEx en tus aplicaciones. Estas instrucciones te guiarán para configurar una organización, crear un proyecto, probar tu integración, mover un proyecto a producción y, en algunos casos, certificar tu API.
Tipos de usuarios:
FedEx ofrece servicios de integración a tres tipos de usuarios: Remitentes de FedEx, soluciones de software verificadas conocidas como Proveedores compatibles con FedEx y Proveedores no compatibles.
Remitente de FedEx:
Empresa que realiza envíos con FedEx y necesita integrar las API de FedEx en sus propias aplicaciones.
Proveedor de soluciones o servicios:
Empresa que necesita integrarse con las API de FedEx para crear una solución, aplicación o plugin que pueda venderse o distribuirse a una organización externa que haga envíos con FedEx. Descubre si tu empresa es un proveedor verificado de FedEx buscando en nuestro directorio global.
- Proveedor compatible con FedEx: Empresa verificada con un acuerdo contractual a través del programa compatible de FedEx.
- Proveedor no compatible: La solución o servicio no está verificado por el programa compatible de FedEx.
Selecciona una de las opciones a continuación que mejor describa tu negocio. No importa tu tipo de usuario, habrá una experiencia de introducción disponible para ti.
- FedEx Shipper: Company who integrates FedEx APIs into their own applications.
- FedEx Compatible Provider: Company certified by the FedEx Compatible program who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
- Non-Compatible Provider: Company who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
Prerequisite
You must have a FedEx user ID to log into the FedEx Developer Portal and create an organization.
Crea una organización, si aún no existe una para tu compañía, o únete a la organización existente de tu compañía.
Crea una organización nueva
Para crear tu propia organización, haz clic en Crear organización en la barra de navegación del lado izquierdo. Si creas tu organización, se te agregará automáticamente como el administrador de esa organización.
- Un administrador puede invitar usuarios a unirse a su organización, asignarles funciones (p. ej., de colaborador o espectador) y proyectos, así como gestionar las cuentas de envío.
- Para obtener más información sobre estas funciones, consulta nuestras Pautas de administración de organizaciones.
Proporciona información sobre la organización
Proporciona el nombre de tu compañía, URL del sitio web y crea un nombre de organización. Dale un nombre a tu organización que otros usuarios reconozcan. Este nombre puede usarse para organizar tu compañía en grupos más específicos (p. ej., departamento, división, región, ubicación), o puede ser el mismo que el nombre de tu compañía.
Una vez que hayas creado tu organización, como administrador, puedes hacer clic en Administrar organización en la navegación de la izquierda para ingresar más detalles.
Añade una cuenta de envío
Abre la pestaña Cuentas de envío. Haz clic en el botón Agregar cuenta.
- Ingresa tu número de cuenta FedEx existente, el alias de la cuenta y la dirección de facturación asociada con la cuenta. Validaremos la dirección de facturación para asegurarnos de que concuerde con los detalles de la cuenta a fin de evitar actividades fraudulentas. Si no tienes una cuenta FedEx existente, abre una nueva cuenta o comunícate con tu representante de atención al cliente de FedEx.
- Acepta el Acuerdo de licencia de usuario final o envíalo a alguien de tu empresa que tenga la autoridad para aceptar el acuerdo.
Agrega una cuenta de facturación
Abre la pestaña Cuentas de facturación. Haz clic en el botón Agregar cuenta de facturación a tu organización.
- Ingresa tu número de cuenta FedEx, el alias de la cuenta y la dirección de facturación dentro de EE. UU. asociada con la cuenta. Validaremos la dirección de facturación para asegurarnos de que concuerde con los detalles de la cuenta a fin de evitar actividades fraudulentas. Si no tienes una cuenta FedEx existente, abre una nueva cuenta o comunícate con tu representante de atención al cliente de FedEx. Las cuentas de facturación deben tener su sede en EE. UU.
- Acepta el Acuerdo de licencia de usuario final o envíalo a alguien de tu empresa que tenga la autoridad para aceptar el acuerdo.
Invitar usuarios
Un administrador puede invitar usuarios a su organización y asignarles funciones y proyectos. Abre la pestaña Usuarios. Haz clic en el botón Agregar usuarios.
- Selecciona una función de usuario: Espectador, Colaborador o Administrador.
- Si tienes algún proyecto existente, asigna un proyecto al usuario. También puedes asignar usuarios a proyectos en cualquier página de descripción general del proyecto.
- Ingresa las direcciones de correo electrónico de los usuarios que deseas que se unan a tu organización bajo el rol seleccionado.
Únete a una organización existente
Paso 1: Pídele al administrador de tu organización que te envíe una invitación.
Si tu compañía ya creó una organización, pídele al administrador de la organización que te invite a unirte. Tendrás 24 horas para aceptar la invitación. Si te pierdes estas ventanas de tiempo, puedes pedir que te la vuelvan a enviar en cualquier momento.
Paso 2: Acepta la invitación.
Para aceptar la invitación, deberás iniciar sesión con tu ID de usuario y contraseña existentes o, si tu ID de usuario existente ya está asociada con una organización, deberás crear una nueva.
Crear un proyecto API
Visita la página Mis proyectos y abre la pestaña API. Haz clic en el botón Crear proyecto de API.
Paso 1: Selecciona las API que quieres incluir en tu proyecto
Revisa las cuotas de las API, los límites de tarifa y los detalles de certificación de la API.
Paso 2: Configura los detalles del proyecto
- Da a tu proyecto un nombre identificable que sea exclusivo de tu organización.
- Selecciona cualquier país al que planees hacer envíos, para que podamos asignarte una cuenta de envío de prueba. Para probar los paquetes de envío a nivel nacional dentro de un país europeo, debes contar con una cuenta de prueba diferente por cada país. Siempre podrás agregar o eliminar países más adelante.
- Para recibir notificaciones sobre las actualizaciones de API más recientes y cualquier información relacionada con los cortes, configura tus preferencias de notificaciones.
Paso 3: Lee y acepta los términos, incluido el Acuerdo de licencia del FedEx Developer Portal
Una vez que aceptes los términos y hagas clic en el botón Crear, verás una pantalla de confirmación. Después, podrás ver tus credenciales de prueba dentro de tu nuevo proyecto.
Crea un proyecto de webhook
Prerequisites
- Review pricing: subscribers are charged a monthly fee based on the count of track numbers. Refer to the Pricing Guide to learn more about pricing.
- Set up accounts: Advanced Integrated Visibility webhook requires a U.S.-based billing account and at least one shipping account, these two account types are mutually exclusive. Only admins can add billing and shipping accounts on the Manage Organization page.
Crea una URL válida (devolución de llamada) en tu aplicación o plataforma de destino
Tu URL de destino se usará para recibir códigos y mensajes de autenticación, así como notificaciones de carga de webhook de FedEx. Tu URL debe utilizar HTTPS para garantizar la seguridad. Tu URL será bloqueada si incluye:
- Aquellos con espacio IP RFC1918
- fedex.com o cualquiera de sus subdominios
- Direcciones IP en el URL (incluido el localhost, 127.0.0.1)
Genera un token de seguridad
Este token de seguridad se puede usar como una clave secreta para autenticar y validar la información transmitida entre tu organización y FedEx. Tu token de seguridad debe incluir:
- Una longitud mínima de 26 caracteres y una longitud máxima de 100 caracteres.
- 1 carácter de letra mayúscula
- 1 carácter de letra minúscula
- 1 carácter numérico
Ejemplo: Y1F6OiVUQW2JPSElmRE9U0IY5
Después de haber definido tu URL y token de seguridad, estás listo para crear un proyecto webhook. Visita la página Mis proyectos y abre la pestaña Webhooks. Haz clic en el botón Crear un proyecto de webhook.
Selecciona el tipo de suscripción
Los remitentes de FedEx pueden suscribir sus eventos a números de cuenta o números de rastreo.
Paso 1: Confirma tu cuenta de facturación y selecciona las funciones
- Revisa la cuenta de facturación predeterminada que aparece para confirmarla o selecciona una diferente de tu organización.
- Configura tu proyecto seleccionando funciones como opciones de prueba de la entrega, opciones de entrega estimada, eventos de rastreo y filtrado basado en eventos.
Paso 2: Ingresa los detalles del proyecto
- Da a tu proyecto un nombre identificable que sea exclusivo de tu organización.
- Ingresa la URL de destino y los detalles del token de seguridad que creaste durante la autenticación previa a la configuración (consulta los pasos anteriores).
- Para recibir notificaciones sobre las últimas actualizaciones de webhook y cualquier información relacionada con interrupciones, ingresa una dirección de correo electrónico y tu idioma preferido.
Paso 3: Lee y acepta los términos
Una vez que aceptes los términos, incluidos el Acuerdo de licencia de FedEx Developer Portal y el formulario de pedido, y hagas clic en el botón Crear, verás una pantalla de confirmación.
Es posible que haya pasos adicionales según la selección del tipo de suscripción. Visita la sección de Documentación para obtener más información.
En la página Resumen del proyecto de API, recupera tus credenciales de prueba (clave de API, clave secreta y cuentas de envío) desde la pestaña Clave de prueba.
Paso 1: Solicita un token de acceso OAuth
El token de acceso OAuth debe utilizarse con cada transacción de API. El token es válido únicamente por una hora, por lo que deberás codificar tu aplicación mediante programación para actualizar el token antes de que caduque la sesión. Consulta la documentación de API Authorization para obtener más detalles.
Paso 2: Revisa la documentación de la API
Haz clic en la documentación de cada una de tus API para leer el contexto comercial y comprender cómo usar la API. Inicia sesión para descargar la colección API JSON a través del botón en la parte superior de la página de documentación. También puedes revisar las solicitudes de ejemplo para el punto final que concuerde con tu integración deseada.
Paso 3: Usa la sandbox para probar transacciones de muestra
Haz clic en el punto final deseado en la navegación izquierda para ir a esa sandbox específica. Identifica las solicitudes de muestra que coinciden con tu caso de uso, luego usa tus credenciales de prueba y las URL de prueba de FedEx para implementar tus llamadas al punto final como se describe en las solicitudes de ejemplo. Verifica que las respuestas de llamadas de API que recibas coincidan con las que se muestran en la documentación. Obtén más información sobre nuestra experiencia de pruebas en la Guía de virtualización de Sandbox.
Pruebas con webhooks
Las pruebas pueden ayudarte a tener una mejor idea sobre si el URL que creaste es válido. Permiten a FedEx identificar tu URL y crear una conexión con este para enviar datos. También te pueden proporcionar datos de prueba de muestra que pueden ayudarte a revisar y confirmar si puedes procesar los datos de rastreo proporcionados en tu aplicación. Sin embargo, las pruebas no autentican tu URL. Visita nuestra documentación de webhook para aprender cómo probar tu URL de webhook.
Visita la página Descripción general del proyecto y abre la pestaña Clave de producción. Los proyectos de suscripción de número de cuenta de visibilidad integrada avanzada no necesitan trasladarse a producción.
Paso 1: Configura el proyecto
- Cambia el nombre de tu clave, según sea necesario.
- Revisa el número de cuenta que seleccionaste en el paso 1 del flujo de creación del proyecto. Este se usa para trasladar tu proyecto a producción. Una vez que tu proyecto esté activo en producción, podrás agregar más cuentas, según sea necesario.
Paso 2: Obtén las claves de proyecto
Copia tu clave API de producción y la clave secreta de producción se mostrará en un lugar seguro. Solo mostramos una vez tu clave secreta de producción para mantenerla segura. Si la pierdes, puedes generar una nueva.
Después de obtener las claves de tu proyecto y hacer clic en Siguiente, verás los detalles de tu proyecto en la pestaña Clave de producción.
- Para agregar más cuentas de envío a tu proyecto, haz clic en Editar en la parte superior de la tabla de cuentas de envío.
Certification steps vary by region
The following steps apply only for customers in the US and Canada. If you live outside of these countries, visit the API Certification page to find support.
Algunas API requieren una certificación de etiqueta de envío para usarse en nuestro entorno de producción. Verifica si tu API requiere certificación.
Paso 1. Desarrolle y evalúe las API de FedEx con su aplicación habilitada para la web
Una vez que haya terminado de desarrollar su aplicación habilitada para la web, es momento de completar la prueba utilizando las credenciales de prueba (cuentas de envío de prueba, la clave de la API y la clave secreta). Su clave de la API de prueba y su clave secreta se mostrarán en la página Descripción general del proyecto y las podrá ver en cualquier momento.
Paso 2: Lleve su proyecto a producción.
Luego de probar las API de FedEx, debe comenzar el proceso de certificación pasando su proyecto a producción en el FedEx Developer Portal. Una vez completado con éxito, verá su clave de la API de producción y la clave secreta. Solo verá su clave secreta de producción una vez, pero podrá volver a generarla después.
Paso 3: Complete la portada de la etiqueta.
Llena completamente la Portada de la etiqueta con la información de contacto adecuada y los servicios que planeas implementar. Incluye tu número de cuenta y clave de producción.
Paso 4: Genera y envía etiquetas de prueba al grupo de análisis de códigos de barras
Genera etiquetas de prueba dentro del entorno de prueba de FedEx asociado con la aplicación y posteriormente envía las etiquetas de prueba a los equipos de evaluación de etiquetas de FedEx para su aprobación. El grupo de análisis de código de barras requiere un tiempo de respuesta de tres días hábiles para la evaluación de la etiqueta.
Sigue estas prácticas recomendadas para evitar retrasos en el procesamiento:
- Las etiquetas se deben imprimir y escanear a un valor mínimo de 600 DPI. NO ENVÍE ARCHIVOS GENERADOS POR LAS API.
- Para impresoras térmicas, el tipo de imagen de etiqueta debe solicitarse de conformidad con el modelo de impresora. Ejemplo: ZPLII para impresoras Zebra.
- Utilice la información de la dirección del remitente o destinatario al momento de crear etiquetas de muestra para la evaluación. Solo cree etiquetas muestra para servicios específicos que se van a solicitar.
- La etiqueta FedEx® cobro contra entrega (C.O.D.) debe incluirse en el C.O.D. correspondiente. Etiqueta de devolución.
- Los envíos de FedEx International Express® también deben incluir la etiqueta auxiliar o secundaria de guía aérea (AWB).
- Los envíos de varias piezas (MPS) deben incluir una etiqueta por cada paquete en el envío.
- Envía por correo electrónico el PDF y la portada de la etiqueta a: label@fedex.com.
- Las etiquetas físicas pueden enviarse a la siguiente dirección:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Si las etiquetas escaneadas no tienen defectos visibles (como líneas en el código de barras, manchas en la tinta o daños físicos), entonces es posible que pasen la inspección y se les otorgue la aprobación.
Si envía etiquetas físicas, ponga atención a la calidad de impresión y al alargamiento o a la contracción accidental de las etiquetas (es decir, la escala). Estas son las dos razones principales por las que las etiquetas no pasan el proceso de evaluación.
Paso 5: Revisa la evaluación de la etiqueta
El grupo de análisis de código de barras evaluará las etiquetas de prueba enviadas y las aprobará o rechazará. El grupo de análisis de código de barras se pondrá en contacto con usted para aprobar o rechazar las etiquetas enviadas. Si las etiquetas se aprueban, siga el siguiente paso. Si las etiquetas se rechazan, corríjalas como se indica y vuelva a enviarlas para su aprobación.
Paso 6: Habilita la aplicación
Una vez que el grupo de análisis de código de barras apruebe las etiquetas de prueba para el estado de producción, autorizarán tus credenciales de producción para transmitir la transacción de etiquetas de envío identificadas y te enviarán una notificación por correo electrónico sobre la certificación exitosa. Tu aprobación es por proyecto.
Paso 7: Remplace la URL y las credenciales.
Remplace la URL y las credenciales de prueba por la URL y las credenciales de producción. Vuelva a probar su implementación en el entorno de producción al usar los datos de muestra.
Prerequisite
Your business must be an existing FedEx Compatible provider. If your business is not in the Compatible program, then change your selection above to “Non-Compatible Provider.”
Paso 1: Recibe la invitación para unirte a la organización
FedEx creará una organización y después invitará a un miembro del equipo a unirse a ella. Este usuario será designado como el «administrador» de tu organización.
Paso 2: Acepta la invitación
Para aceptar la invitación, deberás iniciar sesión con tu ID de usuario y contraseña existentes o, si tu ID de usuario existente ya está asociada con una organización, deberás crear una nueva.
Paso 3: Invita a usuarios
Un administrador puede invitar usuarios a su organización y asignarles funciones y proyectos. Abre la pestaña Usuarios. Haz clic en el botón Agregar usuarios.
- Selecciona una función de usuario: Espectador, Colaborador o Administrador. Obtén más información sobre los roles en nuestra Guía de administración de la organización.
- Si tienes algún proyecto existente, asigna un proyecto al usuario. También puedes asignar usuarios a proyectos en cualquier página de descripción general del proyecto.
- Ingresa las direcciones de correo electrónico de los usuarios que deseas que se unan a tu organización bajo el rol seleccionado.
Visita el Catálogo de las API para determinar cuáles son las API o webhooks adecuados para tu solución. Tu consultor tecnológico de clientes (CTC) de FedEx y el gestor de canales compatibles pueden ayudarte a seleccionar las API adecuadas para tu solución según las necesidades de tu empresa.
Paso 1: Completa la PIW
Regresa a la Comunidad de proveedores compatibles (CPC) para completar la Hoja de trabajo de información del producto (PIW).
Paso 2: Revisa los proyectos creados por FedEx
Una vez aprobada la PIW, FedEx creará tus proyectos. Cada versión de cada una de tus soluciones tendrá un proyecto por separado en el FedEx Developer Portal.
Paso 3: Asiste a la demostración de API con tu equipo
El equipo compatible de FedEx, junto con los equipos de CTC y verificación de FedEx, organizarán una demostración técnica de las API con tu equipo. El equipo de FedEx hablará sobre la verificación del programa compatible, las nuevas características y funcionalidades de la API y responderá preguntas.
En la página Descripción general del proyecto API, recupera tus credenciales de prueba (clave API y clave secreta) desde la pestaña Clave de prueba.
Paso 1: Crea claves de cliente
Usa la API de registro de credenciales para crear claves de cliente. Esta es una API privada que solo se encuentra en la sección API en la parte inferior de la página Descripción general del proyecto API.
Paso 2: Solicita un token de acceso OAuth
El token de acceso OAuth debe utilizarse con cada transacción de API. El token es válido únicamente por una hora, por lo que deberás codificar tu aplicación mediante programación para actualizar el token antes de que caduque la sesión. Consulta la documentación de API Authorization para obtener más detalles. Cuando vea el código de muestra, asegúrate de que se elija Revendedor en la lista desplegable de muestras.
Paso 3: Revisa la documentación de la API
Haz clic en la documentación de cada una de tus API para leer el contexto comercial y comprender cómo usar la API. Inicia sesión para descargar la colección API JSON a través del botón en la parte superior de la página de documentación. También puedes revisar las solicitudes de ejemplo para el punto final que concuerde con tu integración deseada.
Paso 4: Usa la sandbox para probar transacciones de muestra
Haz clic en el punto final deseado en la navegación izquierda para ir a esa sandbox específica. Identifica las solicitudes de muestra que coinciden con tu caso de uso, luego usa tus credenciales de prueba y las URL de prueba de FedEx para implementar tus llamadas al punto final como se describe en las solicitudes de ejemplo. Verifica que las respuestas de llamadas de API que recibas coincidan con las que se muestran en la documentación. Obtén más información sobre nuestra experiencia de pruebas en la Guía de virtualización de Sandbox.
Paso 5: Verifica cada solución
Después de probar completamente tus soluciones, envía casos de prueba al equipo de verificación para verificar cada solución. FedEx revisará completamente todo lo enviado y te informará una vez que tu verificación sea aprobada.
Pruebas con webhooks
Si tu organización tiene acceso a webhooks, las pruebas pueden ayudarte a tener una mejor idea sobre si el URL que creaste es válido. Permiten a FedEx identificar tu URL y crear una conexión con este para enviar datos. También te pueden proporcionar datos de prueba de muestra que pueden ayudarte a revisar y confirmar si puedes procesar los datos de rastreo proporcionados en tu aplicación. Sin embargo, las pruebas no autentican tu URL. Visita nuestra documentación de webhook para aprender cómo probar tu URL de webhook.
A continuación, FedEx trasladará tus proyectos a producción. Visita la página Descripción general del proyecto de API y abre la pestaña Clave de producción. Haz clic en el enlace Generar clave secreta debajo de la columna Clave secreta.
Ahora puede volver a poner a prueba su implementación en el entorno de producción utilizando datos de muestra.
Prerequisite
You must have a FedEx user ID and account to log into the FedEx Developer Portal and create an organization.
Crea una organización si aún no existe una para tu compañía o únete a la organización existente de tu compañía.
Crea una organización nueva
Para crear tu propia organización, haz clic en Crear organización en la barra de navegación del lado izquierdo. Si creas tu organización, se te agregará automáticamente como el administrador de esa organización.
- Un administrador puede invitar usuarios a unirse a su organización y asignarles funciones (p. ej., colaborador o espectador) y proyectos.
- Para obtener más información sobre estas funciones, consulta nuestra Guía de administración de organizaciones.
Paso 1: Proporciona información sobre la organización
- Proporciona el nombre de tu compañía, URL del sitio web y correo electrónico de la empresa para la verificación.
- Crear un nombre de organización. Dale un nombre a tu organización que otros usuarios reconozcan. Este nombre puede usarse para organizar tu compañía en grupos más específicos (p. ej., departamento, división, región, ubicación), o puede ser el mismo que el nombre de tu compañía.
- Ingresa la información de la ubicación donde se encuentra tu empresa y dónde planeas vender o distribuir tu solución de software.
Paso 2: Agrega y autentica la cuenta
Ingresa tu número de cuenta FedEx existente, el alias de la cuenta y la dirección de facturación asociada con la cuenta. Validaremos la dirección de facturación para asegurarnos de que concuerde con los detalles de la cuenta a fin de evitar actividades fraudulentas. Si no tienes una cuenta FedEx existente, abre una nueva cuenta o comunícate con tu representante de atención al cliente de FedEx.
- Como proveedor externo que ingresa al Programa Integrador de FedEx, la cuenta utilizada para este registro inicial debe pertenecerte a ti como Integrador. No se permite el uso de una cuenta de cliente final.
- Esta cuenta se establecerá como la cuenta de facturación predeterminada para tu organización.
Paso 3: Lee y acepta los términos
Una vez que aceptes el Acuerdo de desarrollador y los Manuales del programa, verás una pantalla de confirmación. Como administrador de tu nueva organización, puedes hacer clic en Administrar organización en la navegación de la izquierda para ver o editar detalles.
Paso 4: Invita a usuarios
Un administrador puede invitar usuarios a su organización y asignarles funciones y proyectos. Abre la pestaña Usuarios. Haz clic en el botón Agregar usuarios.
- Selecciona una función de usuario: Espectador, Colaborador o Administrador.
- Si tienes algún proyecto existente, asigna un proyecto al usuario. También puedes asignar usuarios a proyectos en cualquier página de Descripción general del proyecto.
- Ingresa las direcciones de correo electrónico de los usuarios que deseas que se unan a tu organización bajo el rol seleccionado.
Únete a una organización existente
Paso 1: Pídele al administrador de tu organización que te envíe una invitación.
Si tu compañía ya creó una organización, pídele al administrador de la organización que te invite a unirte. Tendrás 24 horas para aceptar la invitación. Si te pierdes estas ventanas de tiempo, puedes pedir que te la vuelvan a enviar en cualquier momento.
Paso 2: Acepta la invitación.
Para aceptar la invitación, deberás iniciar sesión con tu ID de usuario y contraseña existentes o, si tu ID de usuario existente ya está asociada con una organización, deberás crear una nueva.
Visita la página Mis proyectos y abre la pestaña API. Haz clic en el botón Crear proyecto de API.
Paso 1: Selecciona las API que quieres incluir en tu proyecto
Revisa el envío, las tarifas y otras cuotas de API, los límites de tarifas y los detalles de certificación de API.
- Si seleccionas la Ship API o la Open Ship API, Service Availability API y la Trade Documents Upload API se seleccionarán automáticamente, ya que son API esenciales que se deben usar cuando se utiliza la Ship API o la Open Ship API.
Paso 2: Configura los detalles del proyecto
Da a tu proyecto un nombre identificable que sea exclusivo de tu organización.
Paso 3: Lee y acepta los términos, incluido el Acuerdo de licencia del FedEx Developer Portal
Una vez que aceptes los términos y hagas clic en el botón Crear, verás una pantalla de confirmación. Después, podrás ver tus credenciales de prueba dentro de tu nuevo proyecto.
Crea un proyecto de webhook
Prerequisites
- Review pricing: subscribers are charged a monthly fee based on the count of track numbers. Refer to the Pricing Guide to learn more about pricing.
- Set up accounts: Shipment Visibility webhook requires a U.S.-based billing account and at least one shipping account, these two account types are mutually exclusive. Only admins can add billing and shipping accounts on the Manage Organization page.
Crea una URL válida (devolución de llamada) en tu aplicación o plataforma de destino
Tu URL de destino se usará para recibir códigos y mensajes de autenticación, así como notificaciones de carga de webhook de FedEx. Tu URL debe utilizar HTTPS para garantizar la seguridad. Tu URL será bloqueada si incluye:
- Aquellos con espacio IP RFC1918
- fedex.com o cualquiera de sus subdominios
- Direcciones IP en el URL (incluido el localhost, 127.0.0.1)
Genera un token de seguridad
Este token de seguridad se puede usar como una clave secreta para autenticar y validar la información transmitida entre tu organización y FedEx. Tu token de seguridad debe incluir:
- Una longitud mínima de 26 caracteres y una longitud máxima de 100 caracteres.
- 1 carácter de letra mayúscula
- 1 carácter de letra minúscula
- 1 carácter numérico
Ejemplo: Y1F6OiVUQW2JPSElmRE9U0IY5
Después de haber definido tu URL y token de seguridad, estás listo para crear un proyecto webhook. Visita la página Mis proyectos y abre la pestaña Webhooks. Haz clic en el botón Crear un proyecto de webhook.
Selecciona el tipo de suscripción
Los remitentes de FedEx pueden suscribir sus eventos a números de cuenta o números de rastreo.
Paso 1: Confirma tu cuenta de facturación y selecciona las funciones
- Revisa la cuenta de facturación predeterminada que aparece para confirmarla o selecciona una diferente de tu organización.
- Configura tu proyecto seleccionando funciones como opciones de prueba de la entrega, opciones de entrega estimada, eventos de rastreo y filtrado basado en eventos.
Paso 2: Ingresa los detalles del proyecto
- Da a tu proyecto un nombre identificable que sea exclusivo de tu organización.
- Ingresa la URL de destino y los detalles del token de seguridad que creaste durante la autenticación previa a la configuración (consulta los pasos anteriores).
- Para recibir notificaciones sobre las últimas actualizaciones de webhook y cualquier información relacionada con interrupciones, ingresa una dirección de correo electrónico y tu idioma preferido.
Paso 3: Lee y acepta los términos
Una vez que aceptes los términos, incluidos el Acuerdo de licencia de FedEx Developer Portal y el formulario de pedido, y hagas clic en el botón Crear, verás una pantalla de confirmación.
Es posible que haya pasos adicionales según la selección del tipo de suscripción. Visita la sección de Documentación para obtener más información.
En la página Descripción general del proyecto API, recupera tus credenciales de prueba (clave API y clave secreta) desde la pestaña Clave de prueba.
Paso 1: Solicita un token de acceso OAuth
El token de acceso OAuth debe utilizarse con cada transacción de API. El token es válido únicamente por una hora, por lo que deberás codificar tu aplicación mediante programación para actualizar el token antes de que caduque la sesión. Consulta la documentación de API Authorization para obtener más detalles.
Paso 2: Revisa la documentación de la API
Haz clic en la documentación de cada una de tus API para leer el contexto comercial y comprender cómo usar la API. Inicia sesión para descargar la colección API JSON a través del botón en la parte superior de la página de documentación. También puedes revisar las solicitudes de ejemplo para el punto final que concuerde con tu integración deseada.
Paso 3: Usa la sandbox para probar transacciones de muestra
Haz clic en el punto final deseado en la navegación izquierda para ir a esa sandbox específica. Identifica las solicitudes de muestra que coinciden con tu caso de uso, luego usa tus credenciales de prueba y las URL de prueba de FedEx para implementar tus llamadas al punto final como se describe en las solicitudes de ejemplo. Verifica que las respuestas de llamadas de API que recibas coincidan con las que se muestran en la documentación. Obtén más información sobre nuestra experiencia de pruebas en la Guía de virtualización de Sandbox.
Pruebas con webhooks
Si tu organización tiene acceso a webhooks, las pruebas pueden ayudarte a tener una mejor idea sobre si el URL que creaste es válido. Permiten a FedEx identificar tu URL y crear una conexión con este para enviar datos. También te pueden proporcionar datos de prueba de muestra que pueden ayudarte a revisar y confirmar si puedes procesar los datos de rastreo proporcionados en tu aplicación. Sin embargo, las pruebas no autentican tu URL. Visita nuestra documentación de webhook para aprender cómo probar tu URL de webhook.
Visita la página Descripción general del proyecto y abre la pestaña Clave de producción. Los proyectos de suscripción de número de cuenta de visibilidad integrada avanzada no necesitan trasladarse a producción.
Paso 1: Configura el proyecto
Cambia el nombre de tu clave, según sea necesario.
Paso 2: Obtén las claves de proyecto
Copia tu clave API de producción y la clave secreta de producción se mostrará en un lugar seguro. Solo mostramos una vez tu clave secreta de producción para mantenerla segura. Si la pierdes, puedes generar una nueva.
Después de obtener las claves de tu proyecto y hacer clic en Siguiente, verás los detalles de tu proyecto en la pestaña Clave de producción.
Certification steps vary by region
The following steps apply only for customers in the US and Canada. If you live outside of these countries, visit the API Certification page to find support.
Algunas API requieren una certificación de etiqueta de envío para usarse en nuestro entorno de producción. Verifica si tu API requiere certificación.
Paso 1. Desarrolle y evalúe las API de FedEx con su aplicación habilitada para la web
Una vez que termines de desarrollar tu aplicación habilitada para la web, es momento de completar las pruebas usando las credenciales de prueba (clave de la API de prueba y clave secreta). Tu clave de la API de prueba y tu clave secreta se mostrarán en la página Descripción general del proyecto y las podrás ver en cualquier momento.
- Identifica todos los casos de prueba para las regiones o territorios donde deseas validar e implementar tu solución. Los casos de prueba se pueden encontrar en la Línea base de casos de prueba del integrador.
- Antes de ejecutar los casos de prueba, necesitas ejecutar las transacciones de registro para los respectivos números de cuenta de prueba disponibles en la línea base del caso de prueba.
- Después, ejecuta todos los casos de prueba para las regiones o territorios donde deseas validar e implementar tu solución.
Paso 2: Completa la PIW y la Portada de validación
Llena por completo la Hoja de trabajo de información del producto (PIW) y la Portada de validación del integrador con la información de contacto adecuada, así como los servicios y capacidades que planeas ofrecer.
Paso 3: Genera y envía entregables al equipo de Validación
Recopila los siguientes entregables y comprímelos en un archivo .zip y envíalo por correo electrónico a validationmtp@fedex.com. Te recomendamos que envíes tus archivos en un archivo .zip para reducir el riesgo de que su envío sea bloqueado por el proveedor de correo electrónico.
- PIW(s) completadas para todos los territorios o regiones indicados (formato: PDF)
- Portada de validación completa (formato: PDF)
- Capturas de pantalla de lo siguiente (formato: PDF):
- Tu solución orientada al cliente mostrando Servicios de FedEx/Manejo especial
- Declaración de descargo de responsabilidad
- Acuerdo de licencia de usuario final
- Flujo de registro del cliente final
- Transacciones de registro de clientes finales: autenticación multifactor que incluye factura y PIN disponible para SMS, llamadas y correo electrónico (formato: archivos de solicitud o respuesta JSON)
- Copias escaneadas de etiquetas impresas reales para todos los casos de prueba incluidos en la línea base de casos de prueba para los territorios donde deseas que se valide tu solución (formato: PDF o PNG)
- Transacciones de envío de tres casos de prueba, uno para cada tipo de imagen de etiqueta: PDF, PNG y ZPL. (formato: archivos de solicitud/respuesta JSON)
Sigue estas prácticas recomendadas para evitar retrasos en el procesamiento:
- Las etiquetas se deben imprimir y escanear a un valor mínimo de 600 DPI.
- Para impresoras térmicas, el tipo de imagen de etiqueta debe solicitarse de conformidad con el modelo de impresora. Ejemplo: ZPLII para impresoras Zebra.
- Los envíos de FedEx International Express® también deben incluir la etiqueta auxiliar o secundaria de guía aérea (AWB).
- Los envíos de varias piezas (MPS) deben incluir una etiqueta por cada paquete en el envío.
Paso 4: Revisa la evaluación de la etiqueta
El equipo de Validación evaluará los entregables enviados y aprobará o rechazará el envío. El equipo de Validación se pondrá en contacto contigo con respecto a la aprobación o rechazo del envío. Si se aprueban los entregables, continúa con el siguiente paso. Si se rechazan los entregables, corrige las transacciones, pantallas o etiquetas según las instrucciones y vuelve a enviarlos para su aprobación.
Paso 5: Habilita la aplicación
Una vez que el equipo de Validación apruebe el estado de producción de todos los entregables, autorizarán tus credenciales de producción para transmitir la transacción de etiqueta de envío identificada y te notificarán por correo electrónico sobre la certificación exitosa. Tu aprobación es por proyecto.
Paso 6: Sigue las instrucciones posteriores a la validación
Revisa las instrucciones posteriores a la validación y síguelas según sea necesario.
