Introducción
API

SFTP
En esta página

Requisitos previos de la integración
¿Qué necesitas desarrollar para completar la integración?
Administración y acceso de tokens
Endpoints de producción: Partner API/Orders

Cómo integrarte#

Esta sección cubre los aspectos básicos de cómo integrarte. Haz clic en los siguientes enlaces para acceder a cada sección del proceso de integración según sea necesario, o simplemente desplázate hacia abajo en la página:

Requisitos previos de la integración#

Para ser elegible para esta integración, debes tener lo siguiente:

  • Solución de picking propia: Ya estás utilizando tu propia solución de picking interna o de terceros para cumplir con los pedidos.

  • Capacidad de desarrollo de API: la capacidad de desarrollar una API internamente o acceder a soporte de terceros para el desarrollo de API.

  • Preparación técnica: debes tener la capacidad técnica y la infraestructura para recibir actualizaciones de pedidos en su webhook.

Si cumples con ambos requisitos, estás listo y puedes comenzar el proceso de integración. Para integrarte con nuestra Partner API, también debes ser uno de nuestros partners y asegurarte de tener:

  • Acceso a Partner Portal: una herramienta de back office mediante la cual puedes supervisar los pedidos, las operaciones de la tienda, exportar los pedidos, administrar el catálogo en varias tiendas.

    • Haz clic aquí para obtener más información sobre qué es Partner Portal.

  • Acceso al plugin Shops Integracions: este plugin de Vendor Portal te permite configurar el webhook y generar el token.

    • Haz clic aquí para obtener más información sobre cómo acceder al plugin Shops Integrations

    • Poseer una tienda de pruebas: debes tener una tienda de pruebas en nuestra plataforma correctamente configurada en PedidosYa

¿Qué necesitas desarrollar para completar la integración?#

En términos generales, hay dos cosas que debes hacer:

  1. Configure un Webhook para recibir eventos de pedidos

    • Desarrolla un webhook para recibir eventos de pedidos en vivo

    • Asegúrate de que el webhook esté listo para recibir actualizaciones de cualquier modificación durante el ciclo de vida del pedido (por ejemplo, cambios de estado, cancelaciones)

  2. Integrarte con los Endpoints de Partner API

    • Utiliza el endpoint PUT para modificar los pedidos según sea necesario

    • Utiliza el endpoint GET para recuperar información de pedidos de los últimos 60 días siempre que sea necesario.

Administración y acceso de tokens#

¿Qué es un token y cómo lo uso?#

Un token Bearer API es una forma de demostrar quién es usted al realizar solicitudes API. Es parte del estándar OAuth 2.0 y se incluye en los encabezados de la solicitud para mostrar que tiene permiso para acceder a ciertos datos o servicios.

Cómo funciona#

  • Obtén el Token: utilizando el Plugin Shops Integrations

  • Usa el Token: cada vez que realices una solicitud API, incluye el token en el encabezado

Por qué es útil#

  • No es necesario tener nombres de usuario y contraseñas en cada solicitud

  • El servidor no tiene que recordar quién eres (solo verifica el token)

¿Qué necesito para acceder a él?#

Debes tener acceso de administrador, para el Plugin de Shops Integrations en Partner Portal para generar el token Bearer API. Puedes ver esta información paso a paso a continuación.

Pasos para la autenticación y el acceso a la API

  1. Generar un token API

    • Paso 1: Ve a Partner Portal > Shops Integrations

    • Paso 2: Ve a Configuración > API > Sección Administración de tokens, ingresa un nombre basado en su caso de uso

    • Paso 3: Genera un token Bearer. Puedes crear hasta 11 tokens y no tienen vencimiento

  2. Asegura tus tokens

    • Asegúreate de que los tokens se almacenen de forma segura y no se compartan con los equipos de soporte

Aquí te mostramos cómo generar su token

Cosas importantes para recordar sobre los tokens API#

  • Cuando creas un token, ¡nunca caduca! Asegúrate y realiza un seguimiento de tus tokens API, y nunca los compartas con otras personas, ni siquiera con nuestro equipo de soporte

  • Cada token API debe tener asignado un nombre específico que corresponda a su caso de uso previsto, es decir: Gestión de Catálogo, Gestión de Órdenes, Gestión de Promociones

  • Se pueden crear hasta 11 tokens a la vez

  • Los tokens son válidos para todas las tiendas de tu cadena (razón social)

  • Dado que los tokens se administran a través del Plugin Shops Integrations, es recomendable limitar el acceso a ese plugin a las personas de tu organización que realmente lo necesiten.

  • Para acceder a Partner Portal o Shops Integrations, comunícate con tu Account Manager.

Endpoints de producción: Partner API/Orders#

  • Consulta la sección aquí, que contiene un desglose del contexto y los usos/enlaces a los endpoints.


APIResumenAPICasos de uso - Endpoints Explicados