
Developer Portal
Introducción
La API de registro de cuentas proporciona a los proveedores de soluciones compatibles de FedEx un método seguro para registrar el número de cuenta FedEx de los clientes. También genera las contraseñas child_Key y child_secret, que son necesarias para ejecutar las transacciones en la API, solo tras validar la identidad del usuario mediante varios métodos de identificación. Esto evita cualquier riesgo de acceso no autorizado a la cuenta del remitente y restringe los envíos fraudulentos resultado de sistemas no autorizados.
Detalles de la API de registro de cuentas
La API de registro de cuentas permite validar y autenticar la identidad del remitente mediante un método de autenticación de dos factores. Estos métodos de autenticación son necesarios previo al registro de una cuenta, así como para autenticar y autorizar el acceso a los recursos de FedEx.
Se pueden especificar el número de cuenta y una dirección válida, como se especifica en los sistemas de FedEx para validación. Si la dirección especificada concuerda, entonces, el número de cuenta se valida de nuevo mediante alguno de los siguientes métodos de autenticación.
- Validación de facturas: se pueden especificar los detalles de una factura que no tenga más de 90 días de antigüedad y completar el registro. Los detalles de la factura proporcionados se cotejarán con los detalles de la factura existentes en los sistemas de FedEx.
- Validación del PIN: se puede solicitar recibir un pin de seis dígitos, el cual se enviará al número de teléfono o correo electrónico registrado con el número de cuenta FedEx. El pin de seis dígitos se envía por SMS, llamada o correo electrónico, después, se usa ese mismo pin para validar la cuenta.
- Contactar al soporte técnico de FedEx: se puede contactar al soporte técnico de FedEx y responder ciertas preguntas predeterminadas para validar tu identidad.
Nota: varios intentos sin éxito para la autenticación mediante alguno de estos métodos de validación provocarán que los métodos de validación correspondientes se bloqueen de la cuenta durante 24 horas. Se puede elegir otro método de validación disponible en caso de que falles el método de validación existente.
Tras la validación exitosa, la API generará y arrojará las contraseñas child_Key y child_secret. Se deben usar las contraseñas child_key junto con child_secret, client_Id, y client_secret para obtener el token OAuth, que luego puede usarse como credencial para cada transacción subsecuente de la API.
Nota: las contraseñas client_Id y client_secret se generan cuando el Administrador de canales de FedEx crea un proyecto para ti.
Cómo funciona la API de registro de cuentas
Validación de la dirección
Usa este extremo para especificar y registrar el número de cuenta e ingresar la dirección de facturación a validar.
La información clave de ingreso asociada a esta solicitud es:
- Número de cuenta
- Dirección
- Nombre del cliente
La respuesta exitosa a esta solicitud devolverá una opción para seleccionar el método de autenticación de varios factores para el siguiente paso de la validación.
La respuesta también devolverá el accountAuthToken , que deberá pasarse como uno de los parámetros del encabezado en el método de autenticación de varios factores deseado para el siguiente paso de la validación. Se mostrará un mensaje de error en caso de recibir una respuesta incorrecta.
El mismo extremo también puede usarse para generar las contraseñas child_Key y child_secret si eliges contactar al soporte técnico de FedEx para validar tu identidad. Tras la validación exitosa, la respuesta a esta solicitud arrojará las contraseñas child_Key y child_secret para completar el registro de cuenta.
Validación de facturas
Usa este extremo para especificar los detalles de una factura que no tenga más de 90 días de antigüedad para autenticar tu identidad y completar el registro.
La información clave de ingreso asociada a esta solicitud es:
- Número de factura
- Fecha de factura
- Importe de la factura
- Moneda
Nota:
- La factura que uses no deberá tener más de 90 días de antigüedad.
- El monto de la factura debe especificarse únicamente en el formato de EE. UU. con decimales. Ejemplo: 222,50.
- La validación de la factura fallará si se proporciona un valor incorrecto para la fecha de la factura, el número de la factura, el monto y la moneda.
- Varios intentos de validación sin éxito provocarán que este método de validación se bloquee en tu cuenta durante 24 horas y te pedirán que elijas otro método de validación, incluido contactar al soporte técnico de FedEx.
La respuesta exitosa a esta solicitud arrojará las contraseñas child_key y child_secret para completar el registro y ejecutar las transacciones de la API. Se mostrará un mensaje de error cuando se reciba una respuesta incorrecta.
Generación del pin
Usa este extremo para solicitar un código seguro de seis dígitos o pin como el siguiente paso para autenticar el número de cuenta.
La información clave de ingreso asociada a esta solicitud es la siguiente:
- Opción: especifica el método de envío del código seguro o pin, ya sea por SMS, llamada o correo electrónico
Nota: el pin generado será válido durante 10 minutos.
La respuesta exitosa a esta solicitud generará un código seguro o pin de seis dígitos que se enviará mediante el método de envío seleccionado (SMS, llamada o correo electrónico) al número de teléfono o correo electrónico registrado con el número de cuenta FedEx.
Si la identificación del número de teléfono o del correo electrónico no se encuentra en tu cuenta FedEx, entonces, se te pedirá que realices otro método de validación disponible.
Validación del pin
Usa este extremo para ingresar y validar el código seguro o pin de seis dígitos que recibiste mediante el método de generación de un código seguro o pin a fin de autenticar tu identidad y completar el registro.
La información clave de ingreso asociada a esta solicitud es la siguiente:
- SecureCodePin
Nota: Varios intentos de validación sin éxito provocarán que este método de validación se bloquee en tu cuenta durante 24 horas y te pedirán que elijas otro método de validación, incluido contactar al soporte técnico de FedEx.
La respuesta exitosa a esta solicitud arrojará las contraseñas child_key y child_secret para completar el registro y ejecutar las transacciones de la API. Se mostrará un mensaje de error en caso de recibir una respuesta incorrecta.
Validación al contactar al soporte técnico de FedEx
También se puede llamar al soporte técnico de FedEx si no es posible validar tu cuenta FedEx en línea. El equipo de soporte técnico de FedEx necesitará ciertos detalles para validar tu identidad y autorizar el acceso. Una vez que pases la validación, el soporte técnico de FedEx proporcionará una autorización de «back-end». Después de que se proporciona esta autorización de «back-end», se deberá activar de nuevo el extremo de la validación de la dirección para generar las contraseñas child_Key y child_secret a fin de completar el registro de cuenta.
Nota: la autorización de «back-end» proporcionada por el soporte técnico de FedEx solo estará disponible durante 30 minutos.
Datos de prueba predefinidos para el entorno Sandbox
Puedes usar los siguientes datos de prueba predefinidos para probar los métodos de validación de PIN y validación de facturas mientras se integra a esta API en el entorno de sandbox.
- Para la validación de facturas, usa los detalles a continuación:
"invoiceDetail": {
"number": 234562278,
"currency": "USD",
"date": "YYYY-MM-DD",
"amount": 234.00
}
Nota: Puedes usar cualquier fecha válida en el formato AAAA-MM-DD que no sea superior a 90 días. - Para la validación del PIN, usa cualquiera de los secureCodePin proporcionados a continuación
- 234560, 234561, 234562, 234563, 234564, 234565, 234566, 234567, 234568, 234569
Normas comerciales
- Primero, se deberán autenticar los detalles mediante el extremo validación de la dirección. Este extremo genera el accountAuthToken , que deberá pasarse como uno de los parámetros del encabezado en otros métodos de validación.
- El accountAuthToken será válido durante 30 minutos. Por lo tanto, se deberá completar el siguiente nivel de autenticación dentro de ese plazo.
- Todos los métodos de validación tienen configurados ciertos intentos no exitosos. Una vez que se cruza este umbral de intentos, dicho método de validación se bloqueará en tu cuenta durante 24 horas. Aun así, se pueden elegir otros métodos de validación, incluido contactar a soporte técnico de FedEx.
- La validación de la factura se llevará a cabo sin importar si la factura pertenece a la cuenta principal o a una subcuenta, en relación con la cuenta que se agregará o registrará para el envío.
- El PIN se enviará al teléfono o al correo electrónico asociado con el perfil de facturación del número de cuenta que se está validando.
- El PIN será válido durante 30 minutos. Cuando expira este PIN, es posible generar otro nuevo.
- El PIN se enviará por buzón de voz solo en los EE. UU. y Canadá. Se proporcionarán traducciones a inglés, español y francés canadiense.
Please log in to view this API's documentation.
Enter your user ID and password to log in