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.

     ¡Asegurar tu webhook es obligatorio!

     Por favor, consultá los FAQs

2. Integrar con los endpoints de Partner API

   • Para comenzar a utilizar los endpoints, vas a necesitar tener un chainID, que será utilizado en la URL de la solicitud. Podés solicitar tu chain ID a tu Account Manager o encontrarlo directamente en el plugin de Shops Integrations, dentro de la URL:

     

   • 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 API de tipo Bearer es una forma de demostrar quién sos cuando hacés solicitudes a una API. Forma parte del estándar OAuth 2.0 y se incluye en los headers de la solicitud para indicar que estás autorizado a acceder a ciertos datos o servicios.

¿Cómo funciona?#

• Obtén Client ID y Secret: use el Plugin de Shops Integratrions para obtenerlo

• Crea el Token: Al enviar la solicitud a la API incluyendo el Client ID y el Secret, vas a recibir un token de API que es válido por 2 horas.

• Use el token: cada vez que realices una solicitud a la API, incluye el token en el encabezado

¿Por qué es útil?#

• No es necesario usar 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 de Shops Integrations en Partner Portal pueden generar el token bearer de API desde la administración de tokens en la sección de configuración.

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

1. Generar un Token de API#

   • Paso 1: Ve a Partner Portal > Shops Integrations.

   • Paso 2: Ve a Configuración > API > Sección de administración de tokens, ingresa un nombre basado en tu caso de uso y genera un client_id y client_secret.

   • Paso 3: Realizá una solicitud para para obtener tu access_token en el siguiente endpoint:

https://pedidosya.partner.deliveryhero.io/v2/oauth/token

Incluí tu access_token en el header Authorization de cada solicitud que hagas a la Partner API. Antes del access_token, agregá la palabra Bearer seguida de un espacio:

Authorization: Bearer <access_token>

Cosas importantes que debes recordar sobre los tokens de API#

• Asegurate de guardar tu client_id y client_secret en un lugar seguro; los vas a necesitar cada vez que solicites un token.

• Podés crear hasta 10 client_id dentro de tu chain.

• Cuando generás un token, este expira en 2 horas.

• El token generado es válido para todas las tiendas dentro de tu chain.

• Para acceder al Partner Portal o a Shops Integrations, por favor contactá a tu Account Manager.

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

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