Descripción general de API

¿Cómo funciona Epsilon Retail Media?

La API está organizada en torno a REST. La API contiene URL predecibles orientadas a los recursos y utiliza códigos de respuesta HTTP para indicar errores de API. La API utiliza funciones HTTP integradas, incluida la autenticación HTTP y los verbos HTTP, que entienden los clientes HTTP estándar.

La autenticación en la API se gestiona mediante el uso de claves de API. Las claves API se utilizan durante la comunicación entre su backend y la API.

La API de integración admite la carga de datos de productos, catálogos, clientes y pedidos, lo cual se utiliza para generar anuncios. Puede utilizar la API de integración para solicitar anuncios e informar sobre las interacciones con esos anuncios.

Endpoints de integración

Epsilon Retail Media utiliza varios endpoints para sincronizar datos y generar anuncios. A continuación se proporciona un breve resumen:

EndpointUsoDescripción
catalogsSincronización del catálogo a través de APISe utiliza para crear catálogos mediante API. Para los espacios de nombres de un solo catálogo, esto es algo que el administrador técnico de su cuenta puede organizar por usted.
catalog-productsSincronización de productos a través de APISe usa para crear y actualizar datos de productos dentro de un catálogo.
customersSincronización de datos de clientes a través de APISe utiliza para crear y actualizar datos de clientes dentro de un catálogo.
ordersSincronización de datos de pedidos a través de APISe utiliza para enviar datos de pedidos.
/resource/Informar de impresiones y clics Sincronización de datos de pedidos a través de APISe utiliza para informar de clics e impresiones, así como de pedidos, si se informa de estos través del frontend.
/ads/generateGeneración de anunciosSe utiliza para generar anuncios de productos y banners.
/ads/bannerxGeneración de anunciosSe utiliza para generar anuncios de banner x.

📘

No necesita usar endpoints para la sincronización de catálogos, productos, clientes y pedidos. Epsilon Retail Media admite la sincronización de datos a través de un archivo, lo que puede adaptarse mejor a sus necesidades.

Tipo de contenido y carga

La carga de datos está en formato JSON. La Content-Type para estos endpoints es application/json, que se debe aprobar como encabezado en sus solicitudes de la siguiente manera:

-H "Content-Type: application/json" \

Solicitudes de autenticación

Autenticación básica

Todos los recursos de integración utilizan autenticación básica, que debe indicarse como encabezado con la clave API de la siguiente manera:

-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \

Se puede acceder a su clave API en la sección Configuración de integración del equipo de minoristas. Solo necesitará la clave API secreta.

Autenticación OAuth2.0

El endpoint de generación de anuncios de Epsilon Retail Media también es compatible con OAuth2.0. Consulte Autenticación OAuth 2.0 para obtener más información.

URL básicas

Epsilon Retail Media utiliza diferentes URL de base para los entornos de prueba y producción.

📘

Para recibir su URL de base de prueba, póngase en contacto con Epsilon Retail Media. Una vez que la integración esté en marcha, le proporcionaremos las URL de base de producción.