Aquí tienen una guía sencilla para ayudarles con la integración API de envíos de ShippyPro.
La API de ShippyPro es la forma más sencilla de integrar su sistema con más de 155 transportistas en todo el mundo para enviar sus paquetes. Como API multitransportista para ecommerce, conecta las herramientas que ya utilizan con todos sus transportistas desde una única plataforma de envíos.
Para empezar a usar la API de ShippyPro, primero deben:
¿Necesitan una clave API para una app de terceros de puntos de recogida? Primero, comprueben que su suscripción a ShippyPro incluye acceso a la sección API, llamadas API y generación de claves API.
Pueden mejorar su suscripción ustedes mismos desde Planes en su cuenta. Para precios y gestión del plan, consulten Precios, pagos y planes de ShippyPro.
Por ejemplo, Globe Pick Up es una app de terceros con sus propios precios que permite a sus clientes elegir un punto de recogida en el checkout. Necesita acceso a la API de ShippyPro para transmitir a ShippyPro la información del punto de recogida seleccionado.
Los costes de Globe Pick Up son independientes de su suscripción a ShippyPro. Pagar Globe Pick Up no sustituye la suscripción a ShippyPro necesaria para acceder a la API.
Para orientación sobre envíos a puntos de recogida, consulten Cómo añadir un punto de entrega a mis envíos.
Pueden añadir más de una clave API directamente desde su perfil de ShippyPro. Sigan estos sencillos pasos:
Abran la sección API de su perfil de ShippyPro.
Hagan clic en "Add API" y la clave API se generará automáticamente.
Pueden elegir las funcionalidades de sus claves API en este menú desplegable:
| Tipo de clave API | Qué permite hacer |
|---|---|
| Full Access | La clave API puede usarse para todas las funcionalidades de la API (envíos, consulta de tarifas, acceso a los mapas de Ship&Collect, etc.) |
| Maps | La clave API solo puede usarse para mostrar el mapa PUDO de las funcionalidades de Ship&Collect |
| PII Excluded | Toda la información personal quedará oculta con 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 la documentación.
Con nuestra solución API, pueden hacer que todos sus sistemas (como OMS, WMS, POS, ERP y muchos otros) se comuniquen con sus transportistas mediante una sencilla integración API.
Nuestra API está disponible en 14 lenguajes de programación y en dos tecnologías diferentes, REST y SOAP.
Cada llamada API tiene su propio método: según las últimas actualizaciones, actualmente solo aceptamos el método POST.
Encontrarán su clave API haciendo clic en API.
Una vez copiada su clave API, sigan los pasos explicados aquí: Documentación API > Authentication.
Si reciben el error "API Key cannot access PII methods", deben crear una nueva clave API desde cero y realizar las llamadas con la clave recién creada.
Recuerden configurar la llamada API de la siguiente manera:
Con ShippyPro pueden realizar un máximo de 20 llamadas API cada 10 segundos.
Esto significa que pueden hacer 10 llamadas API en un segundo, pero después solo les quedarán 10 llamadas API para los nueve segundos siguientes.
Cuando las solicitudes superan este límite, la API devuelve el siguiente error: Error: 429 Too Many Requests.
Como alternativa, les sugerimos usar direcciones IP diferentes y aplicar una lógica de balanceo de carga (load balancer) para superar este límite.
Si quieren aumentar este límite, contacten con sales@shippypro.com para pedir un presupuesto.
Desde la sección API, hagan clic en "View API logs" para ver en detalle las solicitudes y respuestas en tiempo real.
Las API (solicitud + respuesta) están en formato JSON.
Producto y recursos
Conecten su OMS, WMS, POS o ERP con sus transportistas mediante una sola API de envíos.
Descubran la API →Vean los transportistas, marketplaces y plataformas de ecommerce que pueden conectar.
Ver integraciones →Creen etiquetas de envío y gestionen todos sus transportistas desde un solo lugar.
Descubran la plataforma →Métodos, autenticación y parámetros para su integración API.
Leer la documentación →Reserven una demo y descubran cómo la API de ShippyPro conecta sus sistemas con más de 155 transportistas.
Pueden probar nuestra API mediante la documentación API o un software externo que admita llamadas API.
Hagan clic en el botón superior derecho "Use the API Console".
Serán redirigidos a nuestra documentación API, donde pueden probar los distintos métodos API que aparecen en el panel de la izquierda.
Tengan en cuenta que las llamadas Ship y Edit generan etiquetas de envío REALES, que se contabilizan dentro de los envíos incluidos cada mes en su plan actual. Les recomendamos usar el transportista Generic para probar estas llamadas.
Para hacer una prueba, seleccionen el método que quieren usar y ejecuten la prueba con el botón "Test request" de la derecha.
Verán una interfaz con el método seleccionado: solo tienen que introducir su clave API en la sección Bearer Token y pulsar "Send" en la parte superior de la pantalla.
Tengan en cuenta que, como Generic no es un transportista real, no es posible generar un número de seguimiento válido. Aprendan a usar el transportista Generic haciendo clic aquí.
Si quieren usar una llamada API que no está incluida en la lista de la API, tendrán que usar otra herramienta como Postman o Insomnia.
En resumen, solo se contabilizan los envíos generados mediante la llamada Ship, y solo los que se generan correctamente. Los que dan error no se incluyen.
La llamada Get Rates simplemente muestra precios y opciones para el envío, por eso no afecta al recuento de envíos.
Además, los pedidos con error no se contabilizan como envíos.
Pueden aplicar en cualquier momento la opción de validación de campos API que prefieran desde la sección API.
Pueden elegir entre tres opciones diferentes, ¡veámoslas!
| Opción de validación | Qué ocurre |
|---|---|
| Enable the blocking validation control on all API requests fields | Si quieren impedir que se envíe la llamada API cuando falten datos o la API no sea válida, pueden seleccionar esta opción para bloquear la generación de la llamada. La solicitud devolverá un error. |
| DO NOT BLOCK but include fields validation suggestions in the API responses | La llamada API se envía igualmente, acompañada de sugerencias útiles para identificar los errores encontrados. |
| DO NOT BLOCK and DO NOT INCLUDE any validation suggestions in the API responses | Permite no bloquear la llamada y no mostrar ninguna sugerencia sobre el error. |
Tengan en cuenta que, si usan nuestra API Console, no podrán editar el esquema de cada llamada y la validación predefinida será la estricta.
Si no quieren que el envío se procese a pesar de los errores de validación, activen la opción "Enable the blocking validation control on all API requests fields". Así no generarán etiquetas vacías en la respuesta.
Consulten este enlace para ver los errores más comunes de la API y cómo resolverlos: Cómo solucionar errores de la API
Una API de envíos permite que sus propios sistemas se comuniquen directamente con los transportistas para crear envíos y obtener tarifas. Con la API de ShippyPro, su OMS, WMS, POS o ERP se conecta con más de 155 transportistas mediante una sola integración.
Hasta 20 llamadas API cada 10 segundos; por encima de ese límite recibirán el error 429 Too Many Requests. Para aumentarlo, contacten con sales@shippypro.com y pidan un presupuesto.
Solo cuentan los envíos generados correctamente con la llamada Ship; las llamadas Get Rates no cuentan. Las llamadas Ship y Edit crean etiquetas reales, así que pruébenlas con el transportista Generic.
Artículos relacionados
Las causas más comunes de los errores de la API de WooCommerce y cómo resolverlos.
Leer más →Las ventajas reales de gestionar todos sus transportistas desde una sola plataforma.
Leer más →Cómo repartir sus envíos entre varios transportistas para reducir riesgos.
Leer más →Los errores más comunes de la API de ShippyPro y cómo resolverlos.
Abrir la guía →Reserven una demo y pongan en marcha su integración API de envíos con ShippyPro.