Cómo integrarte#

Esta sección cubre los aspectos básicos de cómo integrarse. 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 integración

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

• Gestión y acceso de tokens

• Acceso a los endpoints de producción

Requisitos previos de integración#

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

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

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

Si cumples con ambos requisitos, estás listo y en condiciones de 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 puede supervisar los pedidos, las operaciones de la tienda, exportar pedidos y administrar el surtido en varias tiendas.

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

• Acceso al plugin Shops Integrations: 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?#

A grandes rasgos, hay dos cosas que debes hacer:

1. Configura un Webhook para recibir eventos de pedidos

   • Desarrolla un webhook para recibir eventos de pedidos, es decir, READY_FOR_PICKUP y CANCELLED

   • Asegúrate de que el webhook esté configurado y disponible para recibir actualizaciones de pedidos, como cambios de estado y cancelaciones.

2. Integrar con los endpoints de Partner API

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

Gestió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 eres al realizar solicitudes API. Es parte del estándar OAuth 2.0 y se incluye en los encabezados de solicitud para mostrar que tienes permiso para acceder a ciertos datos o servicios.

Cómo funciona#

1. Obtén el token: utilizando el complemento Shops Integrations

2. Utiliza el token: cada vez que realices una solicitud API, incluye el token en el encabezado

Por qué es útil#

1. No necesitas nombres de usuario ni contraseñas en cada solicitud

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

¿Qué necesito para acceder?#

Debes tener acceso de administrador al complemento 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 > Integraciones de la tienda.

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

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

2. Protege tus tokens

   • Asegúrate de que los tokens estén almacenados de forma segura y no se compartan con los equipos de soporte

Aquí te mostramos cómo generar tu token

Cosas importantes que debes recordar sobre los tokens API#

1. 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

2. A cada token API se le debe asignar 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

3. Se pueden crear hasta 11 tokens a la vez

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

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

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

Endpoints de producción: Partner API/Órdenes#

• Puedes encontrar una lista exhaustiva de endpoints disponibles aquí.