1. Crea un proyecto para obtener credenciales
2. Integra las API y prueba tu implementación
3. Lleva tu proyecto a producción
4. Completa tu certificación

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:

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.

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.

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.

• 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.

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.

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.

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.

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.

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

1. Crea un URL válido em tu aplicación o plataforma de destino
2. Genera el token de seguridad
3. Prueba el URL del webhook
4. Valida el URL de destino

Crea un proyecto de webhook

1. Crea un proyecto de webhook para recibir notificaciones de carga configuradas

Prerrequisitos para crear un proyecto de webhook

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:

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

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.

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.

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.

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.

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).

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.

• 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

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:

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.

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.

• Selecciona las funciones que quieres configurar en tu proyecto.
• También puedes editar las funciones más adelante.

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.

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.

  5. Confirma los detalles y acepta los términos

• Revisa los detalles de configuración del proyecto.
• Lee y acepta el Acuerdo de licencia del Developer Portal y confirma que no tienes intención de distribuir tu aplicación.
• Lee y acepta el Acuerdo de precios.
• Una vez que hagas clic en el botón Crear proyecto:

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».

1. FedEx crea una organización de proveedores compatibles.
2. Acepte la invitación.
3. Invite usuarios a su organización.
4. Seleccione las API que necesita para su solución.
5. FedEx crea el(los) proyecto(s).
6. Integre las API en su aplicación y certifíquese en el Programa Compatible.
7. FedEx mueve el(los) proyecto(s) a producción.
8. Generar una clave secreta de producció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.
• Una vez completada la certificación y la integración, podrá distribuir la solución a sus clientes con facilidad.

• 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.

• 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.

• 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.

• 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.

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

• 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.

• 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.

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.

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.

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.

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.

• 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.

• 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!