Cómo empezar
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, validar 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 de soluciones FedEx compatibles, y proveedores integradores de FedEx validados.
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:
Compañía que necesita integrarse con las API de FedEx para crear una solución, una aplicación o un plugin que pueda venderse o distribuirse a una organización externa que haga envíos con FedEx.
- Proveedor compatible con FedEx: Empresa verificada con un acuerdo contractual a través del programa compatible de FedEx.
- Proveedor integrador de FedEx: empresa validada con un acuerdo contractual a través del Programa de integradores 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.
Selecciona para comenzar.
Which of the following best describes your business?
Select user
- FedEx Shipper: Company who integrates FedEx APIs into their own applications.
- FedEx Compatible Provider: Company validated 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.
- FedEx Integrator Provider: Validated company with a contractual agreement through the FedEx Integrator Program.
Requisitos previos
Debes tener una ID de usuario de FedEx para iniciar sesión en el FedEx Developer Portal y crear una organización.
Si tu compañía no tiene una organización, crea una. De lo contrario, únete a una organización ya existente.
Crear una organización nueva
En la barra de navegación, haz clic en Crear o unirte a una organización.
Nota: Como creador, se te designa automáticamente como administrador de la organización.
Los administradores pueden hacer lo siguiente:
Invitar a usuarios para que se unan
Asignar roles a usuarios (por ejemplo, colaborador, espectador) y proyectos
Administrar cuentas de envío
Para obtener más información sobre estas funciones, consulta nuestra Guía de administración de organizaciones.
Para el tipo de compañía, selecciona «Vende o proporciona una solución de software que usa la tecnología de FedEx y es un proveedor integrador validado de FedEx».
Proporciona el nombre de tu compañía, la URL del sitio web y un nombre único para tu organización. El nombre de la organización puede coincidir con el nombre de tu compañía o representar a un grupo específico (departamento, división, región, ubicación). Esta información es necesaria para validar tu solicitud.
Nota: Elige un nombre para la organización que todos los demás usuarios puedan reconocer (por ejemplo, nombre de la compañía, departamento, región, ubicación).
Especifica la ubicación de tu compañía y dónde se venderá o distribuirá tu solución de software.
Agrega una cuenta de facturación y autentícala
Nota: Como proveedor de servicios de transporte y logística del Programa de integradores de FedEx, debes utilizar tu propio número de cuenta. No puedes utilizar la cuenta FedEx de un cliente.
Ingresa tu número de cuenta FedEx. Si aún no tienes una cuenta FedEx, abre una en fedex.com o comunícate con un representante del servicio de atención a clientes de FedEx.
Ingresa un sobrenombre y la dirección de facturación asociada a la cuenta. Selecciona Siguiente.
Nota: La dirección de facturación debe coincidir con los datos que figuran en nuestros registros para esta cuenta. Esta será la cuenta de facturación predeterminada para tu organización.
Para terminar de crear tu organización, debes autenticar tu cuenta. Elige una opción de autenticación (teléfono disponible solo para integradores en EE. UU. y Canadá, correo electrónico, mensaje de texto) y selecciona Siguiente.
Una vez que recibas el código de autenticación, ingrésalo y selecciona Enviar.
Aceptar los términos
Lee el Acuerdo del integrador global y el Manual del programa. Selecciona las casillas de verificación para confirmar que aceptas los términos y, a continuación, selecciona Aceptar.
Aparecerá una pantalla de confirmación. Haz clic en Administrar organización para editar los detalles si es necesario.
Invitar usuarios
Nota: Solo los administradores pueden invitar usuarios.
Selecciona Administrar organización en el menú de navegación de la izquierda.
Ve a la pestaña Usuarios y selecciona Agregar usuarios.
Completa el formulario y asígnales la función adecuada a los nuevos usuarios: espectador, colaborador o administrador.
Para obtener más información sobre las funciones de usuario, consulta la Guía de administración de organizaciones.
Asigna usuarios a proyectos (si corresponde) en el menú desplegable Proyectos.
Ingresa las direcciones de correo electrónico de cada usuario y, a continuación, selecciona Invitar.
Unirse a una organización existente
Solicita una invitación: pídele al administrador de tu organización que te envíe una invitación. Tienes 24 horas para aceptarla antes de que venza. Si es necesario, pídele al administrador que vuelva a enviártela.
Acepta la invitación: inicia sesión con tu ID de usuario y contraseña actuales. Si tu ID ya está vinculado a otra organización, debes crear uno nuevo.
Ú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 la API, los límites de tarifa y los detalles de validació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
Requisitos previos
- Revisa los precios: a los suscriptores se les cobra una tarifa mensual basada en la cantidad de números de rastreo. Consulta la Guía de precios para obtener más información sobre los precios.
- Configura las cuentas: el webhook de la visibilidad integrada avanzada requiere una cuenta de facturación con sede en EE. UU. y al menos una cuenta de envío; estos dos tipos de cuentas se excluyen mutuamente. Solo los administradores pueden agregar cuentas de facturación y envío en la página Administrar organización.
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.
Los pasos de validación varían según la región
Los siguientes pasos se aplican solo para clientes en EE. UU. y Canadá. Si vives fuera de estos países, visita la página Validación de la API para obtener ayuda.
Algunas API requieren una validación de etiqueta de envío para usarse en nuestro entorno de producción. Verifica si tu API requiere validació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, debes comenzar el proceso de validación pasando tu proyecto a producción en el FedEx Developer Portal. Una vez completado con éxito, verás tu clave de la API de producción y la clave secreta. Solo verás tu clave secreta de producción una vez, pero podrás 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 validació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.
Requisitos previos
Tu empresa debe ser un proveedor compatible con FedEx existente. Si tu empresa no está en el programa compatible, cambia tu selección anterior a «Proveedor no compatible».
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.
Requisitos previos
Debes tener una ID de usuario de FedEx y una cuenta para iniciar sesión en el FedEx Developer Portal y crear una organización.
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
En la barra de navegación, haz clic en Crear o unirte a una organización.
Nota: Como creador, se te designa automáticamente como administrador de la organización.
Los administradores pueden hacer lo siguiente:
Invitar a usuarios para que se unan
Asignar roles a usuarios (por ejemplo, colaborador, espectador) y proyectos
Administrar cuentas de envío
Para obtener más información sobre estas funciones, consulta nuestra Guía de administración de organizaciones.
Para el tipo de compañía, selecciona «Vende o proporciona una solución de software que usa la tecnología de FedEx y es un proveedor integrador validado de FedEx».
Proporciona el nombre de tu compañía, la URL del sitio web y un nombre único para tu organización. El nombre de la organización puede coincidir con el nombre de tu compañía o representar a un grupo específico (departamento, división, región, ubicación). Esta información es necesaria para validar tu solicitud.
Nota: Elige un nombre para la organización que todos los demás usuarios puedan reconocer (por ejemplo, nombre de la compañía, departamento, región, ubicación).
Especifica la ubicación de tu compañía y dónde se venderá o distribuirá tu solución de software.
Agrega una cuenta de facturación y autentícala
Nota: Como proveedor de servicios de transporte y logística del Programa de integradores de FedEx, debes utilizar tu propio número de cuenta. No puedes utilizar la cuenta FedEx de un cliente.
Ingresa tu número de cuenta FedEx. Si aún no tienes una cuenta FedEx, abre una en fedex.com o comunícate con un representante del servicio de atención al cliente de FedEx.
Ingresa un sobrenombre y la dirección de facturación asociada a la cuenta. Selecciona Siguiente.
Nota: La dirección de facturación debe coincidir con los datos que figuran en nuestros registros para esta cuenta. Esta será la cuenta de facturación predeterminada para tu organización.
Para terminar de crear tu organización, debes autenticar tu cuenta. Elige una opción de autenticación (teléfono disponible solo para integradores en EE. UU. y Canadá, correo electrónico, mensaje de texto) y selecciona Siguiente.
Una vez que recibas el código de autenticación, ingrésalo y selecciona Enviar.
Aceptar los términos
Lee el Acuerdo del integrador de FedEx y el Manual del programa. Selecciona las casillas de verificación para confirmar que aceptas los términos y, a continuación, selecciona Aceptar.
Aparecerá una pantalla de confirmación. Haz clic en Administrar organización para editar los detalles si es necesario.
Invitar usuarios
Nota: Solo los administradores pueden invitar usuarios.
Selecciona Administrar organización en el menú de navegación de la izquierda.
Ve a la pestaña Usuarios y selecciona Agregar usuarios.
Completa el formulario y asígnales la función adecuada a los nuevos usuarios: espectador, colaborador o administrador.
Para obtener más información sobre las funciones de usuario, consulta la Guía de administración de organizaciones.
Asigna usuarios a proyectos (si corresponde) en el menú desplegable Proyectos.
Ingresa las direcciones de correo electrónico de cada usuario y, a continuación, selecciona Invitar.
Unirse a una organización existente
Solicita una invitación: pídele al administrador de tu organización que te envíe una invitación. Tienes 24 horas para aceptarla antes de que venza. Si es necesario, pídele al administrador que vuelva a enviártela.
Acepta la invitación: inicia sesión con tu ID de usuario y contraseña actuales. Si tu ID ya está vinculado a otra organización, debes crear uno nuevo.
Crear un proyecto API
Ve a la página Mis proyectos y selecciona Crear proyecto.
Completa el campo Nombre del proyecto. El formato de nombre recomendado es «Nombre del proyecto_nombre de la aplicación». Selecciona Siguiente cuando hayas terminado.
Selecciona la API y los productos de visibilidad integrada avanzada para tu proyecto.
Nota: Los productos de visibilidad integrada avanzada solo están disponibles para los proveedores integradores de FedEx en EE. UU.
Nota: Si seleccionas algún producto de pago, se te pedirá que asignes una cuenta de facturación al proyecto y que aceptes los términos requeridos.
Asignar facturación y aceptar condiciones
Asigna una cuenta de facturación de la lista de cuentas agregadas a la organización. Este paso solo es necesario si anteriormente seleccionaste un producto de pago.
Acepta los términos y condiciones asociados al producto.
Confirmar los detalles
Revisa los productos seleccionados. Verifica la cuenta de facturación proporcionada.
Revisa y acepta el Acuerdo de licencia de FedEx Developer Portal.
Haz clic en Crear para generar tu proyecto y ver las credenciales de prueba.
Configurar la visibilidad integrada avanzada en un proyecto
Requisitos previos
Requisitos previos
- Revisa los precios: a los suscriptores se les cobra una tarifa mensual basada en la cantidad de números de rastreo. Consulta el formulario de pedido para obtener más información sobre los precios.
- Configura las cuentas: la visibilidad integrada avanzada requiere una cuenta de facturación con sede en EE. UU. y al menos una cuenta de envío; estos dos tipos de cuentas se excluyen mutuamente. Solo los administradores pueden agregar cuentas de facturación y envío en la página Administrar organización.
Crear una URL de devolución de llamada válida en tu aplicación o plataforma de destino – URL de tu aplicación/plataforma:
Debes usar HTTPS por motivos de seguridad.
No se puede incluir el espacio IP RFC1918, los subdominios de fedex.com ni las direcciones IP directas (por ejemplo, 127.0.0.1).
Generar un token de seguridad
Debe tener una longitud de entre 26 y 100 caracteres e incluir lo siguiente:
- 1 letra mayúscula
- 1 letra minúscula
- 1 número
Ejemplo: Y1F6OiVUQW2JPSElmRE9U0IY5
Configurar visibilidad integrada avanzada
Elige Visibilidad integrada avanzada. Selecciona las funciones, como prueba de entrega, entrega estimada, rastreo de eventos y filtrado basado en eventos
Ingresa tu URL de destino y tu token de seguridad.
Proporciona una dirección de correo electrónico para recibir actualizaciones sobre la visibilidad integrada avanzada y notificaciones de interrupciones del servicio.
Confirmar los detalles
Revisa y acepta el Acuerdo de licencia de FedEx Developer Portal y el formulario de pedido.
Selecciona Crear para completar la configuración.
Nota: Es posible que se apliquen pasos adicionales en función de tu tipo de suscripción. Consulta la documentación para obtener más detalles.
Recuperar credenciales de prueba y comenzar la prueba
Revisa la documentación sobre la API
- Lee la documentación sobre las API para comprender las diversas API que ofrecemos, junto con su contexto empresarial y los procesos de integración.
- Descarga el esquema JSON desde la página de documentación de la API correspondiente.
- Revisa ejemplos de solicitudes para los puntos finales deseados.
Obtén las credenciales de prueba
En la página Descripción general del proyecto, ve a la pestaña Claves API. Tu clave API y tu clave secreta aparecen bajo el encabezado Clave de prueba.
Revisa la documentación sobre la API
- Se requiere un token OAuth para todas las transacciones de la API, el cual vence en una hora.
- Tu aplicación debe actualizar el token antes de que venza.
- Consulta la documentación sobre API Authorization para obtener más detalles.
Prueba las transacciones de API en el sandbox
- Ve a la API correspondiente en el Catálogo de API y selecciona Documentación.
- Selecciona el punto final de la API deseado en el menú de la izquierda.
- Usa las solicitudes de muestra que se ajusten a tu caso de uso.
- Implementa llamadas de API utilizando tus credenciales de prueba y URL de prueba de FedEx.
- Verifica que las respuestas coincidan con la documentación.
- Consulta la Guía de virtualización de Sandbox para obtener más detalles.
Probar la visibilidad integrada avanzada
Las pruebas de visibilidad integrada avanzada validan el formato de URL y ayudan a establecer una conexión entre FedEx y tu aplicación.
Las pruebas proporcionan datos de prueba de muestra para procesar la información de rastreo.
Nota: Las pruebas no autentican tu URL.
Lee la documentación sobre visibilidad integrada avanzada para obtener más información.
Se requiere validación para trasladar las API a producción. El nivel de validación varía según la API.
Desarrollar y probar las API de FedEx
- Usa tus credenciales de prueba (clave API y clave secreta) de la página Descripción general del proyecto.
- Identifica los casos de prueba para las regiones o los territorios en los que tienes previsto implementar tu solución (consulta la Base de referencia de casos de prueba del integrador).
- Antes de ejecutar los casos de prueba, completa las transacciones de registro utilizando los números de cuenta de prueba proporcionados.
- Ejecuta todos los casos de prueba requeridos.
Ve a la página Descripción general del proyecto.
Selecciona Solicitar claves de producción. FedEx recibirá tu solicitud de claves de producción y se te notificará una vez que estén aprobadas.
Completar la PIW y la Portada de validación
Completa la Hoja de información del producto (PIW) y la Portada de validación del integrador con tus datos de contacto y los servicios de FedEx que deseas utilizar.
Enviar entregables
Recopila y comprime los siguientes entregables en un archivo .zip para evitar las restricciones del proveedor de correo electrónico. Luego, envíalos a validationmtp@fedex.com.
Entregables requeridos
- PIW completa (PDF).
- Portada de validación completa (PDF).
Capturas de pantalla (PDF):
Solución orientada al cliente que muestra los servicios y el manejo especial de FedEx
Declaración de descargo de responsabilidad
Acuerdo de licencia de usuario final
Flujo de registro del cliente final
- Transacciones del registro de clientes finales con autenticación multifactor (JSON)
- Etiquetas de envío escaneadas para todos los casos de prueba aplicables (PDF/PNG)
- Transacciones de envío para tres formatos de etiqueta: PDF, PNG y ZPL (JSON) (para las API de envío y de tarifas aplicables)
Mejores prácticas para evitar retrasos
- Las etiquetas deben imprimirse y escanearse con una resolución mínima de 600 DPI.
- Las etiquetas para impresoras térmicas deben ser compatibles con el modelo de impresora (por ejemplo, ZPLII para impresoras Zebra).
- Los envíos FedEx International Express® requieren una etiqueta auxiliar de guía aérea (AWB).
- Los envíos de piezas múltiples (MPS) deben incluir una etiqueta por cada paquete.
Evaluación de etiquetas
El equipo de Validación aprobará o rechazará tu envío.
- Si se rechaza, corrige lo que sea necesario y vuelve a realizar el envío según los comentarios.
- Si se aprueba, recibirás un correo electrónico para confirmarte que la validación se realizó correctamente. Una vez que hayas recibido el correo electrónico, tus credenciales de producción estarán autorizadas para transacciones de etiquetas de envío.
Seguir las instrucciones posteriores a la validación
Revisa e implementa cualquier requisito posterior a la validación según sea necesario.
Una vez que se te notifique que se aprobaron tus claves de producción, recupéralas en la pestaña Descripción general del proyecto.
- Copia y guarda de forma segura tu clave API de producción y tu clave secreta.
- La clave secreta solo se muestra una vez. Si la pierdes, deberás generar una nueva.
