Cómo empezar
Comienza tu integración aprovechando el valor proporcionado por las API de FedEx. Las siguientes instrucciones te guiarán a través del proceso para establecer una organización y crear proyectos, al igual que a cómo empezar a ser un usuario compatible.
- Consulte las API para determinar qué necesita para su aplicación.
- Regístrese o inicie sesión para comenzar la integración con las API de FedEx.
- Cree o únase a una organización.
- Añada una cuenta de envío.
- Añada usuarios a su organización para comenzar a colaborar con sus compañeros de equipo.
- Cree un proyecto para obtener credenciales.
- Ingrese las API a su aplicación y pruebe su implementación.
- Lleve su proyecto a producción.
- Complete su integración.
Paso 1:
Consulte las API para determinar qué necesita para su aplicación.
- Consulte el Catálogo de API para determinar las API correctas para su aplicación.
- Seleccione una API para descubrir su información general, registro de cambios y características clave.
- Revise los documentos de las API para obtener más información sobre los elementos de solicitud y respuesta, ejemplos en el lenguaje de programación de su preferencia, códigos de error y más.
- Revise los Anuncios para conocer las actualizaciones de servicio planeadas y conocer las novedades.
Paso 2:
Regístrese o inicie sesión para comenzar la integración con las API de FedEx.
- Inicie sesión con su ID de usuario y contraseña de fedex.com para comenzar la integración con las API de FedEx.
- Si aún no tiene una ID de usuario, regístrese de forma gratuita.
Paso 3:
Cree o únase a una organización.
Cree una organización si aún no existe una para su empresa o únase a la organización existente de su empresa. Puede tener muchos usuarios asociados con su organización, pero no puede tener muchas organizaciones asociadas con una ID de usuario.
Si crea su organización, se le agregará automáticamente como administrador de esa organización. Un administrador puede invitar usuarios a su organización, asignarles funciones y proyectos, y gestionar las cuentas de envío. Para obtener más información sobre cuáles funciones son las mejores para cada miembro, consulte nuestras Pautas de administración de organizaciones. Para crear su propia organización, haga clic en Mis proyectos y después haga clic en el botón de «Crear organización». Este botón solo se mostrará si todavía no ha asociado su ID de usuario con una organización existente. A partir de ahí, puede comenzar a crear una organización al realizar los siguientes pasos (los que están marcados con un * son opcionales):
- Ingrese un nombre de organización.
- Ingrese las direcciones de correo electrónico de los miembros del equipo que desee invitar. Serán agregados automáticamente como espectadores, sin estar asociados con ningún proyecto.*
También puede unirse a la organización de su empresa al realizar los siguientes pasos:
- Si su empresa ya tiene una organización creada, solicite al administrador de la organización que lo 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.
- Para aceptar la invitación, deberá iniciar sesión con su ID de usuario y contraseña existentes o crear otras si su ID de usuario ya está asociada con una organización.
Paso 4:
Añada una cuenta de envío.
Un administrador puede añadir todas las cuentas de envío que sean necesarias para la organización. Para comenzar, haga clic en el botón «Añadir cuenta» en la pestaña Cuentas de envío de la página Administración de organizaciones. A partir de ahí, puede añadir una cuenta de envío existente a su organización al realizar los siguientes pasos:
- Complete la información de la cuenta.
Ingrese su número de cuenta, cualquier alias de la cuenta y la dirección de facturación asociada con la cuenta. Esto se validará para asegurar que coincida con los detalles de la cuenta y así evitar actividades fraudulentas.
Para ver las cuentas de envío asociadas con tu ID del usuario, dirígete a la página Admin. de envíos. Para crear nuevas cuentas de envíos, comunícate con tu Representante de ventas de FedEx.
- Acuerdo de licencia de usuario final
Después debe aceptar el Acuerdo de licencia de usuario final (EULA) o enviarlo a la parte correcta dentro de la compañía del usuario final para que lo acepte. Puede consultar el estado del EULA en la pestaña Cuentas de envío de la página Administración de organizaciones.
Paso 5:
Añada usuarios a su organización para comenzar a colaborar con sus compañeros de equipo.
Un administrador puede invitar usuarios a su organización y asignarles funciones y proyectos. Para comenzar, haga clic en el botón «Añadir usuarios» en la pestaña de Usuarios de la página Administración de organizaciones. A partir de ahí, puede añadir usuarios al realizar los siguientes pasos (los que están marcados con un * son opcionales):
- Ingrese las direcciones de correo electrónico de los usuarios que necesiten unirse a su organización. Ingrese varias direcciones de correo electrónico al presionar la tecla de espacio, coma, punto y coma, o Intro en su teclado.
- Escoja una función si la opción predeterminada de espectador no cumple con las necesidades de los usuarios.*
- Escoja un proyecto que esté asociado con su organización para asignarlo a los usuarios. Si aún no crea uno, consulte el siguiente paso.*
Un administrador siempre tendrá acceso a todos los proyectos, pero un colaborador o espectador debe ser asignado a un proyecto, a menos que el colaborador lo haya creado. Ya sea que un usuario acepte la invitación o no, usted puede actualizar con rapidez sus proyectos o funciones directamente desde la pestaña Usuarios en la pantalla Administración de organizaciones. Todo lo que necesita es hacer clic en el signo de intercalación al lado de la función o proyecto y aparecerá una lista desplegable con opciones para escoger. Haga su elección y después seleccione el botón «Aplicar» para guardar su selección.
Paso 6:
Cree un proyecto para obtener credenciales.
En la página Mis proyectos, un administrador o colaborador puede crear un proyecto al seleccionar el botón «Crear proyecto». A partir de ahí, pueden comenzar la creación de un proyecto al realizar los siguientes pasos (los que están marcados con un * son opcionales):
1. Crea un proyecto
- Da a tu proyecto un nombre identificable que sea exclusivo de tu organización.
- Para comenzar selecciona al menos una API para agregar a tu proyecto. Siempre podrás agregar o eliminar una API más adelante.
2. Acepta los términos
- Lee y acepta el Acuerdo de licencia del Developer Portal y confirma que no tienes intención de distribuir tu aplicación.
- Selecciona cualquier país al que planees hacer envíos, para que podamos asignarte una cuenta de envío de prueba. Para probar el envío de paquetes 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.*
- Si planeas usar el servicio de devoluciones de FedEx Ground® Economy o FedEx Freight® LTL, selecciona Sí.*
- Al hacer clic en el botón «Crear», verás una pantalla de confirmación. Dentro de tu proyecto nuevo, ahora podrás visualizar tus credenciales de prueba.
Paso 7:
Ingrese las API a su aplicación y pruebe su implementación.
- Recupere las credenciales de prueba (clave de API, clave secreta y cuenta[s] de envío) en la pestaña Clave de prueba de la página Información general del proyecto.
- Solicite una señal de acceso de autorización abierta (OAuth) que deberá usarse en cada transacción de API. La sesión para cada 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.
- 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.
- Implemente sus llamadas en estos extremos como se describe en las solicitudes de ejemplo, configurándolas para usar sus credenciales de prueba.
- Compruebe que las respuestas de llamadas de API que reciba coincidan con las que se muestran en la documentación.
- 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.
Paso 8:
Lleve su proyecto a producción.
En la página Información general del proyecto, haga clic en la pestaña Clave de producción. A partir de ahí, puede comenzar el traslado de su proyecto a producción al realizar los siguientes pasos (los que están marcados con un * son opcionales):
- Configure el proyecto.
- Renombre su Clave de producción de API.*
- En este momento, se requiere agregar una cuenta de envío, pero puede agregar más después de que su proyecto se haya movido con éxito a producción. Si no tiene cuentas de envío asociadas con su organización o si el EULA no se firmó para las cuentas de envío que ya se agregaron a su organización, estas no aparecerán en la lista desplegable.
- Obtenga claves de proyecto.
- A continuación, se mostrarán la Clave de producción de API y la Clave secreta de producción. Asegúrese de copiarlas en una ubicación segura.
- Solo mostramos una vez su Clave secreta de producción para mantenerla segura. Si la pierde, puede generar una nueva.
Paso 9:
Complete su integración.
- Algunas API requieren una certificación de etiqueta básica o de envío para su uso en nuestro entorno de producción. Complete el proceso de certificación para cualquier API en su proyecto con este requisito.
- Después de habilitar y certificar todas las API, actualice sus 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.
- Vuelva a probar su implementación en el entorno de producción al usar los datos de muestra.
- ¡Disfrute de los beneficios de su nueva integración!
¿Usted no es un desarrollador o no está seguro de estar listo para integrar con las API de FedEx? Obtenga más información para conocer lo que la integración podría hacer por su empresa.
- FedEx crea una organización de proveedores compatibles.
- Acepte la invitación.
- Invite usuarios a su organización.
- Seleccione las API que necesita para su solución.
- FedEx crea el(los) proyecto(s).
- Integre las API en su aplicación y certifíquese en el Programa Compatible.
- FedEx mueve el(los) proyecto(s) a producción.
- Generar una clave secreta de producción.
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 su 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.
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.
- 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.
Diríjase al Catálogo de las API para determinar las API adecuadas para su solución. Su consultor tecnológico de clientes (CTC) de FedEx y el gestor de canales compatibles pueden ayudarle a seleccionar las API adecuadas para su solución según las necesidades de su 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.
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.
- 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.
- 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.
- 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.
- 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.
- Implemente sus llamadas en estos extremos como se describe en las solicitudes de ejemplo, configurándolas para usar sus credenciales de prueba.
- Compruebe que las respuestas de llamadas de API que reciba coincidan con las que se muestran en la documentación.
- 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.
- 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.
Paso 8:
Generar una clave secreta de producción.
- Deberá generar su 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!
