Como funcionan las APIs de ShippyPro y como debes integrarlas

La API de ShippyPro es la manera más fácil de integrar tu sistema con más de 140 Transportistas en todo el mundo para enviar tus paquetes.

Veamos como funcional las APIs paso a paso 🔍
​

Índice:

1. Antes de empezar
2. ShippyPro API
3. ¿Cómo puedo probar la API ShippyPro?
4. Cómo funciona la validación de campos de la API
5. Errores y soluciones
   
   

1. Antes de empezar

Para empezar a usar la API de ShippyPro, tendrías que hacer lo siguiente:

1. Crear una cuenta de ShippyPro haciendo click aquí. Si quieres saber como crear una cuenta paso a paso, haz click aquí.

2. Conecta las cuentas de tus Transportistas desde Transportistas y completa la configuración del Transportista. Para más detalles, por favor echa un vistazo a nuestra guía específica que encontrarás aquí.

3. Despues de configurar tu perfil de ShippyPro, lee nuestra Documentación API cuidadosamente. Podrás encontrar toda la información que necesitas para usar la API.

4. Puedes activar la Carpeta de pedidos API para manejar los pedidos directamente desde la platagorma. Descubre aquí como hacerlo.

Puedes añadir más de una Clave API directamente desde tu perfil ShippyPro. Sigue estos sencillos pasos:

• Haz clic en API > API
• Haz clic en Añadir API y la clave API se formará automáticamente.

Tipo de API

Puedes elegir las funcionalidades para tus claves API desde este menú desplegable



Acceso Completo: la clave API puede usarse para todas las funcionalidades de la API (envíos, recuperación de tarifas, acceso a los mapas de Ship&Collect, etc.)

Mapas: la clave API solo puede usarse para mostrar el mapa PUDO para las funcionalidades de Ship&Collect

PII Excluida: toda la Información Personal será oscurecida por esta clave (nombres, direcciones, números de teléfono, etc.)

2. API de ShippyPro

Con nuestra solución API, puedes conseguir que todos tus sistemas (como OMS, WMS, POS, ERP y muchos otros) se comuniquen con tus transportistas mediante una sencilla integración API.

Nuestra API está escrita en 14 lenguajes de programación y en dos tecnologías diferentes, REST y SOAP. Cada llamada a la API tiene su propio método: según las últimas actualizaciones, actualmente sólo aceptamos el método POST.

Encontrarás tu clave API haciendo clic en Integraciones >  > API. 

Una vez que copies tu llave API, sigue estos pasos: Documentación API > Autentificación

Por favor, recuerda configurar las llamadas API de la siguiente manera:

• La llave API deberá ser el usuario o Username

• Deja la contraseña o Password en blanco

¿Cuántas llamadas a la API puedo hacer simultáneamente?

Con ShippyPro puedes hacer hasta un máximo de 20 llamadas API cada 10 segundos.
Esto significa que puedes hacer 10 llamadas a la API en un segundo, pero luego sólo te quedarán 10 llamadas a la API para los siguientes nueve.
 

Cuando los envíos de solicitudes exceden este límite, la API devolverá el siguiente error: Error: 429 Too Many Requests.
Como alternativa, te sugerimos que utilices diferentes direcciones IP y apliques una lógica de equilibrador de carga para superar este límite.
Si deseas aumentar este límite, póngase en contacto con sales@shippypro.com para obtener un presupuesto.


En API > API, puedes hacer clic en Ver registros de API para ver las solicitudes y respuestas en directo con más detalle.

3. ¿Cómo puedo probar la API de ShippyPro?

Puedes probar nuestra API utilizando la API Console o un Software Externo que soporte llamadas API.

¿Cómo funciona la API Console?

Puedes probar nuestras llamadas API desde API > API. Haz clic en el botón superior derecho Usar la console de API:

Obtendrás acceso a la Consola API de ShippyPro, donde podrás probar todas nuestras Llamadas API:

El Transportista Genérico no es un transportista real, por lo que no se generará un número de seguimiento. Aprende a usar el Transportista Genérico haciendo click aquí.

📌Si deseas utilizar una llamada API que no está incluida entre las que figuran en la Console API, debe emplear un software diferente como Postman o Insomnia.

Entonces, ¿qué se cuenta realmente como una llamada API correcta?

En resumen, sólo se contabilizarán los envíos generados a través de la llamada Ship y, por tanto, sólo los generados correctamente. Aquellos que se enfrentaron a Error no serán incluidos.

La llamada GetRates simplemente muestra Precios y Opciones para el envío, por esta razón no afecta al recuento de envíos.

Además, los pedidos con Error no se contabilizarán como un envío correcto.

4. Cómo funciona la validación de campos de la API

Puedes decidir aplicar la mejor opción de validación de Campos API que prefieras en cada momento desde Cuenta ShippyPro > API> API.

Puedes elegir entre tres opciones diferentes disponibles, ¡echémosles un vistazo!

• Habilitar el control de validación de bloqueo en todos los campos de las llamadas API: Si deseas evitar que se envíe la llamada a la API en caso de que falten datos o la API no sea válida, puedes seleccionar esta opción para bloquear la generación de la llamada. De este modo, se producirá un error en la solicitud.
• NO BLOQUEAR pero incluir sugerencias de validación de campos en las respuestas de la API: La llamada a la API se seguirá enviando, acompañada de consejos útiles para identificar los errores encontrados.
• NO BLOQUEAR y NO INCLUIR sugerencias de validación en las respuestas de la API: te permite no bloquear la llamada y no mostrar ninguna sugerencia para el error

📌 Ten en cuenta que si utilizas nuestra API Console, no podrás cambiar el esquema de cada llamada y la validación por defecto será la más compleja.

📌 Si no quieres que el envío se procese a pesar de los errores de validación, simplemente activa la opción Habilitar el control de validación de bloqueo en todos los campos de las llamadas API. De este modo, no se generarán etiquetas vacías en la respuesta.

5. Errores y soluciones

Consulta este enlace para ver los errores más comunes y las resoluciones sobre la API:
​
​Cómo solucionar errores de API