Documentación de la API y Guía de inicio rápido

Propósito: Todo lo que necesitas saber sobre la integración de tu tienda online desarrollada a medida con Sendcloud a través de nuestras APIs (RESTful). 

Enlaces relacionados:

• Referencia de la API de Sendcloud
• Portal para desarrolladores de Sendcloud
• Puntos de servicio para integraciones con la API
• Preguntas frecuentes sobre las APIs de Sendcloud 
• Directrices de integración para marketplaces

En Sendcloud ofrecemos funcionalidades y herramientas que ayudan a las empresas de comercio electrónico a automatizar su proceso de envío. Nuestras funcionalidades totalmente escalables facilitan la vida de los minoristas online, tanto si eres un autónomo o una start-up, como si gestionas una gran operación que envía miles de paquetes al mes a nivel internacional. 

Integración con Sendcloud

Existen dos formas de conectar tu tienda online a Sendcloud:

Integraciones plug and play

Si utilizas un sistema de comercio electrónico como Shopify, WooCommerce, Lightspeed o Magento, no necesitas conocimientos de desarrollo para conectar tu tienda. Ofrecemos aplicaciones y plugins plug-and-play para más de 80 de las plataformas de e-commerce más populares, disponibles para descargar desde el marketplace o la tienda de aplicaciones de tu sistema.

API de Sendcloud

Si tienes una tienda online desarrollada a medida que no está alojada ni creada a través de una plataforma de e-commerce, aquí es donde entran en juego nuestras APIs. Una API permite a los desarrolladores conectarse con los componentes clave de nuestro sistema interno e integrarlos en tu tienda online o sistema. Las APIs de Sendcloud están diseñadas para cubrir cada etapa del proceso de envío.

Nuestras funcionalidades pueden utilizarse conjuntamente o de forma independiente, lo que te da la flexibilidad de diseñar y crear tu propio flujo de trabajo de principio a fin. Nuestras APIs te dan acceso a una amplia gama de opciones de envío nacionales e internacionales de los transportistas comerciales y postales europeos más populares. 

Documentación y referencia de la API 

Si eres un desarrollador con experiencia y quieres empezar rápidamente a trabajar con nuestras APIs, puedes ir directamente a nuestra Referencia de la API o acceder a nuestras Colecciones de Postman.

Si eres nuevo en el uso de APIs y quieres ver una explicación detallada de cómo podría ser tu flujo de procesamiento de pedidos, consulta nuestra documentación de la API. Ofrecemos guías de inicio rápido y tutoriales que te guiarán por los fundamentos, desde crear tu primer pedido y enviarlo con la API hasta crear tu primer envío y comparar tarifas de envío.

¿Qué puedes hacer con nuestras APIs?

• Orders API
  La Orders API te ayuda a preparar tus pedidos para la entrega de forma sencilla y flexible.

• Ship an Order API
  La Ship an Order API es una solución integral para crear etiquetas de envío para tus pedidos. El envío implica varios detalles clave, como el peso, el transportista preferido, el país de destino y el seguro. La Ship an Order API facilita la automatización de todo este proceso.

• Shipments API
  Puedes crear y gestionar envíos de forma programática utilizando la Shipments API. Te permite automatizar todo el ciclo de vida del envío sin necesidad de intervención manual en la plataforma, mientras sigues utilizando tus reglas y valores predeterminados de envío.
  Todos los envíos seguirán siendo visibles en tu cuenta de Sendcloud, por lo que podrás revisarlos, solucionar incidencias o ajustarlos cuando sea necesario.

• Service Points API
  Integra un selector de puntos de servicio en tu checkout, accede a una base de datos global de ubicaciones de puntos de servicio de transportistas y permite que tus clientes elijan un lugar de entrega conveniente para su paquete.

• Returns Portal API
  Permite que tus clientes gestionen sus propias devoluciones creando una versión personalizada del Portal de devoluciones. Puedes combinarlo con la funcionalidad de devoluciones de pago para cobrar proactivamente una tarifa de devolución cuando sea necesario.

• Tracking API
  Recupera el historial completo de seguimiento de un paquete, desde el momento en que se anuncia al transportista hasta que se entrega en la puerta de tu cliente.

• Pick-ups API
  Programa una recogida puntual con un transportista mediante la Pick-ups API y haz que tus paquetes se recojan en tu almacén o tienda dentro de la franja horaria seleccionada.

• Dynamic Checkout API
  Aumenta tu tasa de conversión ofreciendo opciones de entrega al día siguiente, el mismo día y en fecha seleccionada directamente en tu checkout. Configura los métodos de envío por zona de entrega en el panel y luego utiliza la API para recuperar los métodos disponibles y mostrarlos a tus clientes en el checkout.

• Returns API
  Crea devoluciones independientes utilizando la Returns API, incluso si el paquete no se envió originalmente a través de tu cuenta. Accede a una base de datos de métodos de devolución disponibles y valida tu solicitud de devolución antes de generar la etiqueta, lo que te ayudará a evitar cargos innecesarios si el método seleccionado no es aplicable. 

¿Qué es una API?

API significa Interfaz de Programación de Aplicaciones (Application Programming Interface). Una API permite que las aplicaciones se comuniquen entre sí a través de la web. Para recuperar datos de una API, realizas una “solicitud” en un lenguaje de formato como JSON o XML, o en un lenguaje de programación como Python, a un servidor, y el servidor devuelve los datos solicitados en una “respuesta”. Las APIs no son simplemente una base de datos: además de solicitar datos, puedes actualizarlos, crearlos y eliminarlos realizando solicitudes a endpoints específicos.

Por ejemplo, la API de Sendcloud te da acceso al endpoint “Create a Shipment”. Puedes realizar una solicitud a este endpoint para crear un envío en el sistema de Sendcloud proporcionando la información requerida (datos de la dirección, información sobre la opción de envío y más). Para hacer una solicitud, necesitas saber qué información requiere nuestro servidor para crear el envío. Proporcionamos ejemplos de solicitudes y respuestas, además de una lista de campos obligatorios y opcionales que puedes incluir, en nuestra referencia de la API.

¿Por qué usar una API en lugar de una integración plug-and-play?

Los desarrolladores utilizan APIs para integrar funcionalidades específicas en una tienda online o sistema desarrollado a medida. Conectarte a Sendcloud a través de la API te permite personalizar nuestras funcionalidades para adaptarlas a las necesidades de tu negocio, además de integrar nuestras funcionalidades junto con aplicaciones de terceros relacionadas con la facturación y la gestión de almacenes. 

Cuando te integras con Sendcloud mediante una API, tienes total flexibilidad para decidir cómo quieres crear tu flujo de procesamiento de pedidos y logística. Puedes optar por procesar tus pedidos directamente a través de la API o importarlos al panel de Sendcloud y gestionarlos desde allí. Dado que nuestra API te da acceso individual a nuestras funcionalidades clave, puedes decidir cuáles quieres aprovechar e incorporarlas directamente a tu sistema y flujo de trabajo. 

Primeros pasos 

¿Listo para empezar a integrar las APIs de Sendcloud? Antes de comenzar, asegúrate de haber creado una cuenta en Sendcloud y de haber seguido los pasos de nuestra guía Primeros pasos con Sendcloud.

Deberás completar los siguientes pasos antes de que nuestra API acepte tus solicitudes:

1. Configurar tu dirección de remitente y de devolución (opcional)
2. Activar algunos transportistas en tu cuenta
3. Configurar un método de pago (obligatorio antes de poder crear etiquetas de envío). Obtén más información sobre cómo Sendcloud te factura las etiquetas de envío que creas aquí. 

Opcional: No olvides crear una marca, activar las notificaciones de seguimiento y crear tu Portal de devoluciones. 

Autenticación

Sendcloud utiliza Autenticación básica para autenticar las solicitudes a nuestras APIs. Deberás incluir una clave API `Public` y `Private` en el encabezado de cualquier llamada que realices a un endpoint de Sendcloud. 

Ejemplo: 

curl “https://panel.sendcloud.sc/api/v2/parcels” --user “YOUR_API_KEY:YOUR_API_SECRET”

Consulta la sección de Autenticación de nuestro Portal para desarrolladores para ver más ejemplos sobre cómo autenticarte con nuestras APIs. 

Cómo obtener tus claves API

1. Inicia sesión en tu cuenta de Sendcloud y ve a Configuración > Integraciones
2. Busca Sendcloud API en la lista de integraciones y haz clic en Conectar
3. Asigna un nombre a la integración de la API (por ejemplo, “Mi tienda online”) y haz clic en Guardar
4. Tus claves API Public y Secret se generarán automáticamente. Guárdalas en un lugar seguro e inclúyelas en los encabezados de tus solicitudes. La clave Public es tu “usuario” al autenticarte con la API, y la clave Secret (Private) actúa como tu “contraseña”. 

Activar puntos de servicio

En la página de configuración de la integración, como se describe anteriormente en Autenticación, puedes activar o desactivar los puntos de servicio. Para realizar solicitudes a la Service Point API, enviar paquetes a un punto de servicio o mostrar el selector de puntos de servicio en tu checkout, asegúrate de activar los puntos de servicio.

Una vez marcada la casilla para activar los puntos de servicio, puedes seleccionar los transportistas que deseas incluir como métodos de entrega en puntos de servicio y hacer clic en Guardar. 

Crear etiquetas de prueba

Puedes probar nuestras APIs sin preocuparte por cargos inesperados utilizando la opción de envío de Sendcloud ‘Unstamped Letter’ ("shipping_option_code": "sendcloud:letter"). Para obtener más ayuda sobre cómo crear etiquetas de prueba mediante la API, consulta nuestra documentación.

Preguntas frecuentes

Si tienes alguna pregunta sobre el uso de nuestras APIs, puedes consultar nuestra guía Sendcloud APIs - FAQ

Direcciones IP para incluir en la lista blanca