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 la 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

Para integrarte con nuestra API de Partner, también debes ser uno de nuestros partners y asegurarte de tener:

Acceso a Partner Portal (nuestro portal de autoservicio para partners)
- Haz clic aquí para obtener más información sobre qué es Partner Portal
Acceso al Plugin Shops Integrations en Partner Portal
- Haz clic aquí para obtener más información sobre cómo acceder al Plugin Shops Integrations
Uno o más productos activos en catálogo (para permitir que se generen promociones en estos productos)

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

A alto nivel, hay dos cosas que debes hacer:

Configure un Webhook para recibir eventos de pedidos#
- Paso 1: Desarrolla un webhook para recibir eventos de pedidos en vivo.
- Paso 2: Asegúrate de que el webhook esté listo para recibir actualizaciones de cualquier modificación durante el ciclo de vida de la promoción.
Integrar con los puntos finales de la REST API#
- Paso 1: Utiliza el punto final PUT para crear trabajos de promoción
- Paso 2: Utiliza el punto final GET para recuperar información de estado de la promoción

Gestión y acceso de tokens#

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

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

Cómo funciona#

Obtén el token: utilizando el Plugin Shops Integrations
Utiliza el token: cada vez que realices una solicitud a la API, incluye el token en el encabezado.

Por qué es útil#

No necesitas 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?#

Solo los usuarios con acceso al Plugin Shops Integrations en Partner Portal pueden generar el token de Bearer API desde la gestión de tokens en la sección de settings

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

Generar un token de API
- Paso 1: Vaya a Partner Portal > Shops Integrations.
- Paso 2: Vaya a Configuración > API > Sección de Gestión de Tokens, ingresa un nombre según el caso de uso.
- Paso 3: Genera un token de Bearer. Puedes crear hasta 11 tokens y no tienen vencimiento.
Asegura 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 de la API#

Cuando creas un token, ¡nunca caducan! Asegúrate y realiza un seguimiento de sus tokens de API, y nunca los compartas con otras personas, ni siquiera con nuestro equipo de soporte.
A cada token de API se le debe asignar un nombre específico que corresponda a su caso de uso previsto, por ejemplo: 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 su 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