Cómo empezar

Una vez que haces la integración con FedEx, puedes empezar a aprovechar el valor proporcionado por las API y los webhooks de FedEx. Estas instrucciones te guiarán mediante el proceso de configuración de una organización, creación de proyectos o cómo comenzar como un usuario compatible.


Paso 1:

Explora las API y webhooks

Puedes comenzar a examinar nuestras API y webhooks para determinar cuáles son tus necesidades e identificar las mejores soluciones para tu aplicación.

  • Ve al Catálogo de API para examinarlas.
  • Selecciona una API o webhook para leer un resumen, explorar el registro de cambios y revisar las características clave.
Captura de pantalla de una página de envío y API
  • Revisa los documentos para obtener más información sobre los elementos de solicitud y respuesta, ejemplos en el lenguaje de programación de tu preferencia, códigos de error y más.
Captura de pantalla de la creación de una página de envío
  • Revisa la página «Anuncios para conocer las actualizaciones de servicio planeadas y conocer las novedades.

Paso 2:

Regístrate o inicia sesión

Inicia sesión con tu ID de usuario y contraseña de fedex.com para comenzar la integración con las API y los webhooks de FedEx.

Si aún no tienes tu ID de usuario, regístrate de forma gratuita.


Paso 3:

Cree o únase a 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.

Crear una organización:

Si creas tu organización, se te agregará automáticamente como 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.

Para crear tu propia organización, haz clic en «Crear organización» en la navegación del lado izquierdo.

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.
captura de pantalla de la página Cree su organización

Cómo unirte a una organización:

Puedes unirte a una organización existente al completar los siguientes pasos:

  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, siempre puedes pedir que te la vuelvan a enviar.

  1. 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 4:

Añada una cuenta de envío.

  1. Complete la información de la cuenta.
  • Ingresa tu número de cuenta, cualquier alias de la cuenta y la dirección de facturación asociada con la cuenta. Después validaremos la dirección de facturación para asegurarnos de que concuerde con los detallas de la cuenta a fin de evitar actividades fraudulentas.
  • Para ver las cuentas de envío asociadas con tu ID de usuario, ve a la página «Administrar organización» y la pestaña «Cuentas de envío». Para crear nuevas cuentas de envíos, comunícate con tu Representante de ventas de FedEx.
captura de pantalla de la página Agregar cuenta de envío

  1. Acuerdo de licencia de usuario final
  • Después, tienes que aceptar el Acuerdo de licencia de usuario final (EULA) o enviarlo a otra persona dentro de la compañía de usuario final que pueda aceptar el acuerdo. Puedes ver el estado del EULA en la página «Administrar organización», en la pestaña «Cuentas de envío».

     

captura de pantalla de la página Ejecutar EULA

Paso 5:

Agrega usuarios a tu organización

Un administrador puede invitar usuarios a su organización y asignarles funciones y proyectos. Para comenzar, puedes hacer clic en el botón «Agregar usuarios» en la página «Administrar organización» al completar los siguientes pasos (los que están marcados con un * son opcionales):

  1. Ingresa las direcciones de correo electrónico de los usuarios

  • Ingresa las direcciones de correo electrónico de cualquier usuario que quieras invitar a unirse a tu organización. Puedes ingresar varias direcciones de correo electrónico al presionar la tecla de espacio, coma, punto y coma, o Intro en tu teclado entre direcciones.
  1. Selecciona las funciones de los usuarios

  • Escoge una función de usuario diferente si la opción predeterminada de espectador no cumple con las necesidades de ese usuario.*
  1. Asigna usuarios a un proyecto

  • Si ya creaste un proyecto, puedes asignar usuarios al proyecto.*
captura de pantalla de la página Agregar usuarios

Un administrador siempre tendrá acceso a todos los proyectos, pero un colaborador o espectador debe asignarse a un proyecto (a menos que el colaborador cree el proyecto, en cuyo caso se asignará en automático a ese proyecto).

Ya sea que un usuario acepte la invitación o no, puedes actualizar con rapidez sus proyectos o funciones directamente desde la página «Administrar organización», en la pestaña «Usuarios».

  • Haz clic en el signo de intercalación al lado de la función o proyecto y aparecerá una lista desplegable con opciones
  • Selecciona una opción, después, selecciona el botón «Aplicar» para guardar tu selección.
captura de pantalla de la página Administrar organización


Paso 1: 

Cree un proyecto para obtener credenciales.

En la página «Mis proyectos», ve a la pestaña «API».
 

Un administrador o colaborador de tu organización puede crear un proyecto de API al hacer clic en el botón «Crear un proyecto de API».

Antes de comenzar, primero tendrás que informarnos por qué necesitas acceder a las API de FedEx. Aparecerá una ventana modal y te presentará opciones desplegables. Tendrás que seleccionar la opción que mejor identifique las necesidades de integración de tu empresa con las API de FedEx.

Si te identificas como remitente, puedes empezar a crear tu proyecto. Es un proceso de tres pasos:

  1. Seleccione las API

Selecciona las API que quieres incluir en tu proyecto. Con base en las API que elijas, es posible que necesites hacer algunas selecciones adicionales.

Si seleccionas una API de Rastreo, también deberás hacer lo siguiente:

  • Selecciona un número de cuenta para asociarlo con tu clave de producción.
  • Revisa las cuotas de la API de Rastreo, los límites de tarifa y los detalles de certificación de la API.
  • Elige si quieres suscribirte o no a los correos electrónicos que te notificarán si excediste tu cuota de transacciones.
crea un proyecto de API

  1. Configurar el proyecto

Ingresa algunos detalles del proyecto, como nombre y ubicación de envío.

  • 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, puedes configurar tus preferencias de notificaciones.
step2

  1. Confirmación de detalles

Revisa los detalles de tu proyecto y después acepta los términos y condiciones.

  • Lee y acepta el Acuerdo de licencia del FedEx Developer Portal y confirma que no tienes intención de vender o distribuir tu aplicación.
  • Al hacer clic en el botón «Crear», verás una pantalla de confirmación. Después, podrás ver tus credenciales de prueba de tu nuevo proyecto.
step3

Paso 2:

Integra las API y prueba tu implementación

En la página «Resumen del proyecto», recupera tus credenciales de prueba (clave de API, clave secreta y cuentas de
envío) desde la pestaña «Clave de prueba». Después, podrás hacer lo siguiente:

  • Solicita un token de acceso de autorización abierta (OAuth) que deberá usarse en 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 los documentos de autorización de API para obtener más detalles.
  • Haz clic en cualquier documento para que tus API lean el contexto comercial de cada API, de forma que puedas entender cómo usarlas. También puedes revisar las solicitudes de ejemplo para el punto final que concuerde con tu integración deseada.
  • Implementa tus llamadas en estos puntos finales como se describe en las solicitudes de ejemplo, configurándolas con tus credenciales de prueba.
  • Verifica que las respuestas de llamadas de API que recibas coincidan con las que se muestran en la documentación.
  • Prueba tu implementación dentro del entorno de prueba de FedEx al utilizar las credenciales de prueba y los URI de prueba de FedEx.
API project overview

Paso 3:

Lleva tu proyecto a producción

Haz clic en la pestaña «Clave de producción». Ahora puedes comenzar el traslado de tu proyecto a producción al
completar los siguientes pasos.

 

En el paso de Configura el proyecto:

  • Puedes renombrar 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é vivo en producción, podrás agregar más cuentas, según sea necesario.
production key tab

En el paso «Obtener las claves del proyecto»:

  • Se mostrarán la clave de producción de API y la clave secreta de producción. Asegúrate de copiarlas en una ubicación segura.
  • Solo mostramos una vez tu clave secreta de producción para mantenerla segura. Si la pierdes, puedes generar una nueva.
  • Haz clic en Siguiente.
production key step2

Ahora se te regresará a la página «Resumen del proyecto». Aquí podrás agregar más cuentas asociadas con tu proyecto.

En la página «Resumen del proyecto»:

  • Haz clic en los 3 puntos verticales (o menú de kebab) para agregar más cuentas asociadas con tu proyecto.
  • Después, haz clic en «Editar».

Esto te llevará a la página «Clave de API», donde puedes agregar cualquier cuenta adicional que quieras asociar con tu clave de producto para este proyecto.

API project overview after steps

Paso 4:

Completa tu certificación

  1. Algunas API requieren una certificación de etiqueta de envío para usarse en nuestro entorno de producción. Completa el proceso de certificación para cualquier API en tu proyecto con este requisito.
API Certification
  1. Después de habilitar y certificar todas las API, actualiza tus solicitudes de API al reemplazar los URI, las claves y las cuentas de envío de prueba con los URI, las claves y las cuentas de envío de producción.

  2. Vuelva a probar su implementación en el entorno de producción al usar los datos de muestra.

  3. ¡Disfrute de los beneficios de su nueva integración!


Prerrequisitos para crear un proyecto de webhook


Paso 1:

Crea un URL válido em tu aplicación o plataforma de destino

Crea un URL válido en tu aplicación o plataforma de destino para recibir los códigos o mensajes de autenticación y las notificaciones de carga de rastreo de webhook de FedEx.

Requisitos de URL:

 

  • Solo se acepta el protocolo HTTPS
  • Tu URL podría bloquearse si cumple alguna de las siguientes condiciones:
    • Incluye espacio IP RFC1918
    • Incluye a fedex.com o a cualquiera de sus subdominios
    • Incluye direcciones IP en el URL (incluido el localhost, 127.0.0.1)
  •  


    Paso 2:

    Genera el token de seguridad

    Este token de seguridad se puede usar como una clave secreta para autenticar y validar la información transmitida entre tú (el cliente) y FedEx.

    Requisitos del token de seguridad:

    • una longitud mínima de 25 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
    Security token

    Paso 3:

    Prueba el URL del webhook

    Probar tu URL es un paso opcional que te puede ser de ayuda.

    Las pruebas pueden ayudarte a tener una mejor idea sobre si el URL que creaste en el paso 1 es válido. Permiten a FedEx identificar tu URL y crear una conexión con tu URL para enviar datos. Las pruebas 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 autenticar tu URL.

    Visita nuestra documentación de webhook para aprender cómo probar tu URL de webhook.


    Paso 4:

    Valida el URL de destino

    Usando el método del algoritmo de hash HMAC SHA256, configura un proceso de autenticación para validar la información transmitida entre tu URL de destino y FedEx.

    screenshot of Validate destination URL
    1. Cuando haces clic en «Crear», FedEx genera una cadena de respuesta al azar, que se te envía en el cuerpo de la solicitud. En su lugar, se espera que le devuelvas esta cadena de respuesta a FedEx en el cuerpo de respuesta.
    example
    1. Inicializa los códigos de autenticación de mensajes (MAC) usando el algoritmo o procedimiento HMAC SHA256 para el hash (o combinar) la cadena de respuesta y el token de seguridad (o la clave secreta) para formar una firma de hash.
    img2
    1. Responde a FedEx con cadenas-de-confirmación y respuestas-de-cadenas-de-confirmación juntas en el cuerpo de respuesta, así como el código de estado HTTP 200 (OK) o 202 (ACEPTADO).
    image3
    1. Ahora, FedEx validará la cadena de confirmación y la respuesta de la cadena de confirmación.
    • Después de que FedEx reciba el cuerpo de la respuesta, FedEx validará la cadena-de-confirmación y la respuesta-de-la-cadena-de-confirmación (o la firma hash que se generó antes) al compararlas con la cadena de confirmación y la firma hash generadas por FedEx, respectivamente.
    img4
    • Si tanto la firma de «cadena-de-confirmación» como la de HMAC coinciden, entonces, la validación y el flujo de trabajo fueron exitosos. De lo contrario, el proceso de validación fallará y se mostrará el mensaje de error correspondiente.

    Crea un proyecto de webhook


    Paso 1:

    Crea un proyecto de webhook para recibir notificaciones de carga configuradas

    En la página «Mis proyectos», ve a la pestaña «webhooks».

    Un administrador o colaborador de tu organización puede crear un proyecto de webhook al hacer clic en el botón de proyecto «Crear un webhook».

    Antes de comenzar, primero tendrás que informarnos por qué necesitas acceder a los webhooks de FedEx. Aparecerá una ventana modal y te presentará opciones desplegables. Tendrás que seleccionar la opción que mejor identifique las necesidades de integración de tu empresa con los webhooks de FedEx.

    Si te identificas como remitente, puedes empezar a crear tu proyecto al completar los siguientes pasos:

    screenshot of create a webhook page
    1. Identifica tus necesidades comerciales
    • Selecciona la opción que mejor identifique por qué tu empresa quiere la integración con los webhooks de FedEx.
    identify your business needs
    1. Selecciona un nivel y las características de este
    • Selecciona un nivel de webhook básico o avanzado para tu proyecto con base en las necesidades de tu proyecto.
    • Siempre puedes editar tu elección de nivel más adelante.
    • Cada nivel viene con una tarifa de suscripción mensual.
    tire and tire features
    • Selecciona las funciones que quieres configurar en tu proyecto.
    • También puedes editar las funciones más adelante.
    feature selection
    1. Configura los detalles del proyecto
    • Dañe un nombre identificable a tu proyecto
    • Proporciona el URL de destino pregenerado y los detalles de los tokens de seguridad, que se pueden crear durante la autenticación previa a la configuración.

     

    Nombre del campo Descripción


    Nombre del proyecto de webhook







    URL de destino

    Este es un nombre de proyecto de webhook único y no vacío que no debe repetirse en ningún otro proyecto de webhook.

    • El nombre del proyecto de webhook se autocompleta con una sugerencia de nombre, que puede editarse según sea necesario.


    Este es el URL donde recibirás los datos o carga del evento de rastreo.

    • Deberás proporcionar un URL de destino válido y que funcione.
    • El URL de destino proporcionado debe estar en un formato estandarizado sintáctico (URL de https seguro, no incluyas fedex.com o sus subdominios en el URL).
    • Puedes repetir el URL de destino en varios webhooks.





    Token de seguridad
     

    Este se usa como un secreto compartido para autenticar y validar la respuesta del rastreo de webhook.

    • El valor del token debe tener una longitud mínima de 25 caracteres y una máxima de 100 caracteres.
    • Se debe incluir al menos 1 mayúscula, 1 minúscula y 1 carácter numérico.
    • Puedes repetir este token de seguridad en varios webhooks.
    • El token de seguridad se usará para crear un hash basado en la firma del código de autenticación de mensajes (HMAC) para la validación de la respuesta.

    Idioma de carga (país)




    Tipo de rastreo
     

    Selecciona tu idioma de preferencia para tus traducciones de datos de rastreo en la lista desplegable.



    Selecciona el tipo de respuesta en la que deben recibirse los datos de rastreo

    • Respuesta de rastreo detallada: la respuesta de rastreo detallada consiste en datos de rastreo seguros con todo el historial de eventos.
    • Respuesta de rastreo por evento específico: este tipo de respuesta consiste en datos de rastreo seguros solo con la información del evento más reciente.


    Dirección de correo electrónico
     

    Proporciona una dirección de correo electrónico para recibir notificaciones cuando se hagan cambios en tu proyecto de webhook (p. ej., se creó, editó o canceló).






    Idioma de correo electrónico (país)
     

    Selecciona el idioma de tu preferencia en el que te gustaría recibir notificaciones por correo electrónico de webhook por parte de FedEx.

    Estos son los idiomas permitidos para las llamadas por correo electrónico:

    • Inglés (Estados Unidos)
    • Inglés (Canadá)
    • Francés (Canadá)
    • Español (Estados Unidos)
       
    create webhook step2

    1. Elige las cuentas
    • Elige de una lista de números de cuenta elegibles (basados en EE. UU. o Canadá) que quieras asociar con tu proyecto.
    note

      5. Confirma los detalles y acepta los términos

    1. Si la solicitud creada se valida y procesa con éxito, se te llevará a una pantalla de confirmación.
    • Si la validación no tiene éxito o falla, recibirás un mensaje de error.
    1. Tu proyecto de rastreo de webhook tendrá un ID de webhook generado por el sistema y se mostrará con un estado «Activo».
    terms

    Paso 1: 

    FedEx crea una organización de proveedores compatibles

    • 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.
    • Una vez completada la certificación y la integración, podrá distribuir la solución a sus clientes con facilidad.

    Paso 2:

    Acepte la invitación.

    • Para obtener acceso a los artefactos de integración de la API y a la documentación, acepte la invitación. Para aceptar la invitación, deberá iniciar sesión con su ID de usuario y contraseña de FedEx o crear una nueva si aún no tiene credenciales.
    Accept invite

    Paso 3:

    Invite usuarios a su organización.

    • Como administrador, puede invitar a cualquier miembro del equipo que necesite acceso al proyecto o a la organización. Para obtener más detalles sobre las diferentes funciones, consulte la Guía de administración de organizaciones.
    Manage org
    • Si ya se creó su organización, pida al administrador de la organización o a FedEx que le invite a unirse. Tendrá 24 horas para aceptar la invitación, pero si rebasa este periodo, puede solicitar que se la envíen de nuevo.

    Paso 4:

    Seleccione las API que necesita para su solución.

    • Visita el Catálogo de las API para determinar cuáles son las API adecuadas 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.

    API Catalog
    • Seleccione una API para encontrar una descripción general, registros de cambios y características clave.

    Address validation API
    • Consulte la documentación de la API para descubrir elementos de solicitud y respuesta, ejemplos en el idioma de su preferencia, objetos de error y más.

    Address validation API-intro
    • Vuelva a Salesforce para completar la Hoja de trabajo de información del producto (PIW) y enliste las API que le gustaría que se agregaran a su solución.


    Paso 5:

    FedEx crea el(los) proyecto(s).

    Una vez aprobada la PIW, FedEx creará su(s) proyecto(s). Cada versión de cada una de sus soluciones tendrá un proyecto por separado dentro del FedEx Developer Portal. Si un usuario no es un administrador de la organización, tendrá que ser invitado para ver cada proyecto. 

    Este también será el momento en el que el equipo compatible de FedEx, junto con los equipos de CTC y certificación de FedEx, organizarán una demostración técnica de las API con su equipo. El equipo de FedEx le explicará las nuevas características y funcionalidades disponibles con la versión de las API que está adoptando. El equipo podrá responder las preguntas técnicas sobre las API, las pruebas de las API y todos los procesos que deben completarse para iniciar el proceso de «certificación» de las API.

    * Certificación: proceso definido por el Programa Compatible de FedEx para satisfacer los requisitos de cumplimiento del programa. La Certificación del Programa Compatible se requiere para garantizar que todos los proveedores compatibles implementen, comercialicen y distribuyan la tecnología de FedEx a los remitentes (clientes) tal y como se define en los estándares de tecnología y servicio de FedEx.


    Paso 6:

    Integre las API en su aplicación y certifíquese en el Programa Compatible.

    1. Ahora tendrá acceso a su clave API de prueba y a su clave secreta de prueba para empezar a realizar transacciones. Recupérelos desde la pestaña de claves de prueba de la página de Información general del proyecto.
    API project overview
    1. Para crear claves de cliente, tendrá que utilizar la API de registro de credenciales, la cual es una API privada que sólo se encuentra en la sección de API de cada uno de sus proyectos.
    2. Una vez que haya creado unas cuantas claves de cliente, continúe y solicite una señal de acceso OAuth que se utilizará con cada transacción de la API. La sesión para la señal es válida únicamente por una hora, por lo que deberá codificar su aplicación mediante programación para actualizar la señal antes de que caduque la sesión. Consulte los documentos de autorización de API para obtener más detalles. Cuando vea el código de muestra, asegúrese de que se elija «revendedor» en la lista desplegable de muestras.
    API Authorization
    1. Seleccione los documentos para las API en su página Claves de prueba y lea el contexto comercial para comprender mejor cómo usar la API seleccionada. Revise las solicitudes de ejemplo para el extremo que coincide con la integración que desea.
    2. Implemente sus llamadas en estos extremos como se describe en las solicitudes de ejemplo, configurándolas para usar sus credenciales de prueba.
    3. Compruebe que las respuestas de llamadas de API que reciba coincidan con las que se muestran en la documentación.
    4. Pruebe por completo su implementación dentro del entorno de prueba de FedEx al utilizar las credenciales de prueba y los URI de prueba de FedEx.
    5. Tras realizar todas las pruebas de sus soluciones, certifique cada una de ellas en Salesforce. FedEx revisará completamente todo lo enviado y le informará una vez que su certificación sea aprobada.

    Paso 7:

    FedEx mueve el(los) proyecto(s) a producción.

    • A continuación, FedEx trasladará su(s) proyecto(s) a producción.
    • A continuación, podrás ver tu clave de API de producción debajo de la pestaña de Clave de Producción de la página de Información general del proyecto.
    API project overview tab2

    Paso 8:

    Generar una clave secreta de producción.

    • Deberás generar tu clave secreta de producción al hacer clic en el enlace «Generar clave secreta» que se encuentra 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.
    • ¡Disfrute de los beneficios de su nueva integración!