1. Crear un proyecto para obtener las credenciales
2. Integrar las API y probar su implementación
3. Trasladar su proyecto a producción
4. Completar su certificación

Un administrador o colaborador de su organización puede crear un proyecto de API haciendo clic en el botón Crear un proyecto de API.

Antes de comenzar tendrá que informarnos de por qué necesita acceder a las API de FedEx. Aparecerá un mensaje modal que le presentará opciones desplegables. Debe seleccionar la opción que mejor describa las necesidades de su empresa para integrar las API de FedEx.

Si se identifica como remitente, puede empezar a crear su proyecto. Se trata de un proceso de tres fases:

Seleccionar API

Seleccione las API que quiere incluir en su proyecto. En función de las API que seleccione, puede que tenga que hacer algunas selecciones adicionales.

Si selecciona la API de seguimiento, también tendrá que:

• Seleccionar un número de cuenta para asociarlo a su clave de producción.
• Revisar las cuotas y límites de tarifas de la API de seguimiento y los detalles de certificación de la API.
• Seleccionar si quiere o no recibir e-mails que le avisarán cuando supere su cuota de transacciones.

Configurar proyecto

Introduzca algunos datos del proyecto, como el nombre y la ubicación de envío.

• Póngale a su proyecto un nombre identificable que sea exclusivo en su organización.
• Seleccione todos los países en los que desea realizar envíos para poder asignarle una cuenta de envío de prueba. Para probar paquetes de envío nacionales en un país europeo, tiene que disponer de una cuenta de prueba independiente para cada país. Podrá añadir/eliminar países posteriormente.
• Para recibir notificaciones sobre las últimas actualizaciones de las API y cualquier información relacionada con interrupciones, puede ajustar sus preferencias de notificación.

Confirmar detalles

Revise los detalles de su proyecto y luego acepte los términos y condiciones.

• Lea y acepte el acuerdo de licencia del FedEx Developer Portal y, además, acepte que no está tratando de vender o distribuir su aplicación.
• Una vez que haga clic en el botón «Crear», aparecerá una pantalla de confirmación. Luego podrá ver las credenciales de prueba en su nuevo proyecto.

• Solicitar un token de acceso OAuth que se tendrá que utilizar con cada transacción de API. El token solo es válido durante una hora, por lo que tendrá que codificar mediante programación la aplicación para actualizar el token antes de que finalice la sesión. Consulte la documentación de autorización de la API para obtener más información.
• Hacer clic en cualquier documento para las API y lea el contexto empresarial de cada API para comprender mejor cómo usarla. También puede revisar solicitudes de muestra para el punto de conexión que se corresponda con la integración deseada.
• Implementar las llamadas a estos puntos de conexión como se indica en las solicitudes de ejemplo, configurándolas con sus credenciales de prueba.
• Verificar que las respuestas de llamada de API que recibe se corresponden con las mostradas en la documentación.
• Probar su implementación en el entorno de prueba de FedEx empleando las credenciales y las URL de prueba de FedEx.

Dentro del paso Configurar proyecto:

• Puede renombrar su clave cuando lo necesite.
• Revise el número de cuenta que seleccionó en el paso 1 del proceso de creación del proyecto. Este se usa para trasladar el proyecto a producción. Una vez que su proyecto esté en producción, podrá añadir más cuentas si es necesario.

Dentro del paso Obtener claves del proyecto:

• Aparecerán su clave API y su clave secreta de producción. Asegúrese de copiarlas en un lugar seguro.
• Para garantizar la protección de su clave secreta de producción, solo la mostraremos una vez. Si la pierde, puede generar una nueva.
• Haga clic en Next (Siguiente).

Ahora se le redireccionará a la página Resumen del proyecto. Aquí podrá añadir más cuentas asociadas a su proyecto.

En la página Resumen del proyecto:

• Haga clic en los 3 puntos verticales para añadir más cuentas asociadas a su proyecto.
• Luego haga clic en Editar.

Esto le llevará a la página Clave API, en la que podrá añadir cuentas adicionales que quiera asociar a su clave de producción para este proyecto.

1. Algunas API requieren certificaciones de etiquetas de envío para su uso en nuestro entorno de producción. Complete el proceso de certificación para todas las API del proyecto con este requisito.

1. Una vez que todas las API se hayan certificado y habilitado, actualice sus solicitudes de API cambiando los URI, las claves y las cuentas de envío de prueba por sus URI, claves y cuentas de envío correspondientes de producción.

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

3. ¡Disfrute de las ventajas de su nueva integración!

Prerrequisitos para crear un proyecto de webhook

1. Cree una URL válida en su plataforma/aplicación de destino
2. Generar token de seguridad
3. Probar URL del webhook
4. Validar URL de destino

Crear un proyecto de webhook

1. Cree un proyecto de webhook para recibir notificaciones de cargas configuradas

Prerrequisitos para crear un proyecto de webhook

Cree una URL válida en su plataforma/aplicación de destino para recibir códigos/mensajes de autenticación y notificaciones de carga de webhook de seguimiento desde FedEx.

Requisitos de la URL:

Este token de seguridad puede usarse como clave secreta para autenticar y validar información transmitida entre usted (el cliente) y FedEx.

Requisitos del token de seguridad:

• Una longitud mínima de 25 caracteres y máxima de 100 caracteres
• 1 mayúscula
• 1 minúscula
• 1 número

Probar su URL es un paso adicional que puede resultar conveniente.

La prueba puede ayudarle a tener una mejor idea sobre si la URL creada en el paso 1 es válida. Permite a FedEx identificar su URL y crear una conexión con su URL para enviar datos. La prueba puede también puede proporcionarle datos de muestra que pueden ayudarle a comprobar si puede procesar los datos de seguimiento proporcionados en su aplicación. No obstante, la prueba no autentica su URL.

Visite nuestra documentación sobre webhook para conocer cómo probar la URL de su webhook.

Mediante el algoritmo HMAC SHA256, configure un proceso de autenticación para validar la información transmitida entre su URL de destino y FedEx.

1. Al hacer clic en Crear, FedEx genera una cadena de comprobación al azar, la cual se le envía en el cuerpo de la solicitud. Se espera de su parte que devuelva esta cadena de comprobación a FedEx en el cuerpo de la respuesta.

1. Inicialice el código de autenticación de mensaje (MAC) usando el procedimiento/algoritmo HMAC SHA256 para hacer hash en (o combinar) la cadena de comprobación y el token de seguridad (la clave secreta) a fin de formar una firma hash

1. Responda a FedEx con challengeString y challengeStringResponse en el cuerpo de la respuesta, además del código de estado de HTTP 200 (OK) o 202 (ACEPTADO).

1. FedEx validará entonces la cadena de comprobación y la respuesta a la cadena de comprobación.

• Después de que FedEx reciba el cuerpo de la respuesta, validará la challengeString y la challengeStringResponse (o la firma hash generada previamente) comparándola con la challengeString y la firma hash generada por FedEx, respectivamente.

• Si tanto la «challengeString» como las firmas HMAC coinciden, la validación y el flujo de trabajo habrán sido satisfactorios. De lo contrario, el proceso de validación fallará y se mostrará un mensaje de error.

Crear un proyecto de webhook

En la página Mis proyectos, vaya a la pestaña Webhooks.

Un administrador o colaborador de su organización puede crear un proyecto de webhook haciendo clic en el botón de proyecto Crear un webhook.

Antes de comenzar tendrá que informarnos de por qué necesita acceder a los webhooks de FedEx. Aparecerá un mensaje modal que le presentará opciones desplegables. Debe seleccionar la opción que mejor describa las necesidades de su empresa para integrar los webhooks de FedEx.

Si se identifica como remitente, puede empezar a crear su proyecto completando los siguientes pasos:

1. Identificar las necesidades de su empresa

• Seleccione la opción que mejor describa el motivo por el que su empresa quiere integrar las webhooks de FedEx.

1. Seleccionar el nivel y sus prestaciones

• Seleccione un nivel de webhook básico o avanzado para su proyecto en función de las necesidades del mismo.
• Podrá editar su elección de nivel más adelante.
• Cada nivel tiene una cuota de suscripción mensual.

• Seleccione las funciones que quiere configurar con su proyecto.
• Podrá editar las funciones más adelante.

1. Configurar detalles del proyecto

• Póngale a su proyecto un nombre identificable
• Proporcione la URL de destino generada previamente y los detalles del token de seguridad, los cuales se crean durante la autenticación previa.

Elegir cuentas

• Elija a partir de una lista los números de cuenta admisibles (de EE. UU. o Canadá) que quiera asociar a su proyecto.

  5. Confirmar detalles y aceptar condiciones

• Revise los detalles configurados del proyecto.
• Lea y acepte el acuerdo de licencia del Developer Portal y, además, acepte que no está tratando de distribuir su aplicación.
• Lea y acepte el Acuerdo de precios.
• Cuando haga clic en el botón Crear proyecto:

1. Si la solicitud de creación se ha validado y procesado satisfactoriamente, verá una pantalla de confirmación.

• Si no se ha validado satisfactoriamente, aparecerá un mensaje de error.

1. Su proyecto de webhook de seguimiento tendrá entonces una ID del webhook generada por el sistema y se mostrará el estado «Activo».

1. FedEx crea una organización de proveedores de Compatible.
2. Acepte la invitación.
3. Invite a los usuarios a su organización.
4. Seleccione las API que necesita para su solución.
5. FedEx crea proyectos.
6. Integre las API en su aplicación y certifíquela en el programa Compatible.
7. FedEx traslada proyectos a producción.
8. Genere la clave de producción secreta.

• FedEx creará una organización. A continuación, invitará a un miembro del equipo para que se una a esta. A este usuario se le asignará el rol de administrador en su organización.
• Una vez finalizadas la certificación e integración, podrá distribuir la solución entre sus clientes de manera sencilla.

• Para obtener acceso a los artefactos y documentos de integración de la API, acepte la invitación. Para aceptar la invitación, tendrá que iniciar sesión con su ID de usuario y contraseña de FedEx, o bien crear unos nuevos en caso de que todavía no tenga credenciales.

• Como administrador, puede invitar a cualquier miembro del equipo que requiera acceso al proyecto o a la organización. Para más información sobre los diferentes roles, consulte la Guía de administración de la organización.

• Si ya se ha creado su organización, pida al administrador de esta o a FedEx que le invite a unirse. Tendrá 24 horas para aceptar la invitación, pero si se le pasa el plazo, puede pedir que se la vuelvan a enviar.

• Visite el Catálogo de API para determinar cuáles son las API adecuadas para su solución. Su consultor de tecnología para el cliente (CTC) de FedEx y el gestor del Compatible Channel le pueden ayudar a la hora de elegir las API adecuadas para su solución, según las necesidades de su negocio.

• Seleccione una API para ver el resumen, el registro de cambios y las funciones principales.

• Consulte la documentación de la API para conocer los elementos de solicitud y respuesta, los ejemplos en el lenguaje que haya elegido, los objetos de error y mucho más.

• Vuelva a Salesforce para completar la hoja de información sobre el producto (Product Information Worksheet, PIW) y enumerar las API que le gustaría incorporar a su solución.

Cuando se haya aprobado la PIW, FedEx le creará sus proyectos. Cada versión de sus soluciones tendrá un proyecto individual dentro del FedEx Developer Portal. Si un usuario no es administrador de la organización, necesita una invitación para poder ver todos los proyectos. 

También será así cuando los equipos de FedEx Compatible, FedEx CTC y de certificación organicen una demostración técnica de las API con su equipo. El equipo de FedEx planteará las nuevas características y funciones disponibles con la versión de las API que vaya a implementar. El equipo podrá exponer las dudas técnicas sobre las API, las pruebas de API y cualquier proceso que deban completar para la certificación de las API.

* Certificación: proceso establecido por el programa FedEx Compatible para cumplir los requisitos del programa de cumplimiento. Es necesaria la certificación del programa Compatible para garantizar que todos los proveedores de Compatible implementan, comercializan y distribuyen la tecnología de FedEx a los remitentes (clientes) tal y como lo establecen los estándares de tecnología y servicio de FedEx.

1. En este punto, tendrá acceso a su clave de prueba de API y su clave de prueba secreta con las que empezar a ejecutar las transacciones. Las puede recuperar en la pestaña Clave de prueba de la página Resumen de proyecto.

1. Para crear claves de cliente, tiene que usar la API de registro de credenciales, la cual es una API privada que solo encontrará en la sección de API de cada uno de sus proyectos.
2. Cuando haya creado algunas claves de cliente, solicite un token OAuth de acceso para utilizarlo en todas las transacciones de la API. La sesión del token solo es válida durante una hora, por lo que tendrá que programar la aplicación para actualizar el token antes de que finalice la sesión. Consulte la documentación de autorización de la API para obtener más información. Cuando visualice el código de muestra, asegúrese de que se ha elegido “Revendedor” en los ejemplos del desplegable.

1. Seleccione documentos para las API en su página de claves de prueba y lea el contexto empresarial para comprender mejor cómo usar la API seleccionada. Revise solicitudes de muestra para el punto de conexión que se corresponda con la integración deseada.
2. Implemente las llamadas a estos puntos de conexión como se indica en las solicitudes de ejemplo, configurándolas para usar sus credenciales de prueba.
3. Verifique si las respuestas de llamada de API recibidas se corresponden con las mostradas en la documentación.
4. Pruebe por completo su implementación en el entorno de prueba de FedEx empleando las credenciales y los URIs de prueba de FedEx.
5. Tras probar completamente sus soluciones, certifique cada una de ellas en Salesforce. FedEx revisará íntegramente todo lo que envíe y le informará cuando se haya aprobado la certificación.

• En ese momento, FedEx trasladará sus proyectos a producción.
• Entonces, podrá ver la clave de producción de API en la pestaña «Clave de producción» de la página «Resumen de proyecto».

• Tendrá que generar su clave secreta de producción haciendo clic en el enlace de Generar clave secreta, en la columna Clave secreta.
• Ahora puede volver a probar su implementación en el entorno de producción empleando los datos de muestra.
• ¡Disfrute de las ventajas de su nueva integración!