![ShippyPro Logo-1.svg]](https://help.shippypro.com/hubfs/Imported%20sitepage%20images/ShippyPro%20Logo-1.svg){kind=small}
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:
Para empezar a usar la API de ShippyPro, tendrías que hacer lo siguiente:
-
Crear una cuenta de ShippyPro haciendo click aquí. Si quieres saber como crear una cuenta paso a paso, haz click aquí.
-
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í.
-
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.
-
Puedes activar la Carpeta de pedidos API para manejar los pedidos directamente desde la platagorma. Descubre aquí como hacerlo.
Requisitos del plan y apps externas de puntos de recogida
¿Necesitas una clave API para una app externa de puntos de recogida? Primero, comprueba que tu suscripción de ShippyPro incluya el acceso a la sección API, las llamadas API y la generación de claves API.
Puedes cambiar a un plan superior por tu cuenta desde Planes en tu cuenta. Para consultar los precios y la gestión del plan, lee ShippyPro Precios, Pagos y Planes.
Por ejemplo, Globe Pick Up es una app externa con sus propios precios que permite a tus clientes seleccionar un punto de recogida en el checkout. Necesita acceso a las API de ShippyPro para transmitir a ShippyPro la información del punto seleccionado.
📌 Nota: Los cargos de Globe Pick Up son independientes de tu suscripción de ShippyPro. Pagar Globe Pick Up no sustituye la suscripción de ShippyPro necesaria para acceder a las API.
Para consultar cómo enviar a un punto de recogida, lee Cómo añadir un punto de recogida a mis envíos.
Cómo generar tu clave API
Puedes añadir más de una Clave API directamente desde tu perfil ShippyPro. Sigue estos sencillos pasos:
- Haz clic en 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.)
Los parámetros de las llamadas API distinguen entre mayúsculas y minúsculas y deben coincidir exactamente con lo indicado en la documentación.
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 API.
Una vez que copies tu llave API, sigue estos pasos: Documentación API > Autentificación
En caso de que obtengas el error "La clave API no puede acceder a los métodos PII", deberás crear una nueva clave API desde cero y realizar las llamadas con la recién creada.
Para probar solicitudes en la documentación API, introduce la clave API de tu cuenta en el parámetro de autenticación correspondiente. Consulta la sección ¿Cómo puedo probar la API de ShippyPro? más abajo.
¿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 la sección API, puedes hacer clic en Ver registros de API para ver las solicitudes y respuestas en directo con más detalle.
API (Request + Response) están en formato Json
¿Quieres probar una solicitud API? La antigua consola API ya no está disponible. Puedes probar las llamadas directamente en la documentación API o utilizar un software externo compatible con llamadas API.
¿Cómo pruebo una solicitud en la documentación API?
Para hacer pruebas necesitas la clave API de tu cuenta, disponible en la sección API de tu cuenta ShippyPro.
- Abre la documentación API.
- Selecciona el endpoint que quieres probar.
- Haz clic en Test request.
- Introduce tu clave API en el parámetro de autenticación correspondiente.
- Introduce los datos necesarios para la solicitud.
- Ejecuta la prueba y revisa la respuesta.
Tenga en cuenta que las llamadas Ship y Edit generarán etiquetas de envío REALES, que se contabilizarán como parte de los envíos incluidos en su Plan actual cada mes. Se recomienda utilizar el Transportista Genérico para probar estas llamadas.
¿Qué debo comprobar si la prueba devuelve una respuesta 401?
Primero, comprueba que hayas introducido tu clave API en el parámetro de autenticación correspondiente. Es una comprobación inicial: no significa que esta respuesta siempre se deba a una clave ausente.
Para otras indicaciones sobre cómo resolver problemas, consulta Cómo solucionar errores de API.
Tenga en cuenta que, dado que Generic no es un transportista real, no es posible generar un número de seguimiento válido. Aprenda a usar el Transportista Genérico haciendo clic aquí.
📌 Si desea utilizar una llamada API que no está incluida entre las que figuran en la lista de API, deberá utilizar otro software 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
📌 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