Saltar al contenido principal
La API de Toppie permite el acceso programático seguro a la plataforma unificada de retail media de Topsort. Ya sea que estés automatizando la gestión de campañas, creando dashboards personalizados o integrando datos de Toppie en flujos de trabajo existentes, la API proporciona la base para escalar operaciones de retail media más allá de la interfaz de usuario.
La API de Toppie proporciona endpoints públicos para gestionar y analizar cuentas de agencia, campañas y actividad financiera en múltiples socios minoristas.

Referencia de la API de Toppie

Consulta la documentación completa de la API con todos los endpoints disponibles

​
Beneficios Clave

  • Automatizar Operaciones de Campaña - Crea flujos de trabajo para gestionar campañas en minoristas sin intervención manual
  • Integraciones Personalizadas - Conecta datos de Toppie a herramientas de BI y sistemas internos
  • Control de Acceso Seguro - Permisos basados en roles para datos y capacidades

​
Capacidades de la API

La API de Toppie proporciona funcionalidad completa a través de los siguientes endpoints:
Carga, actualiza y gestiona catálogos de productos en socios minoristas. Mantén el inventario sincronizado y asegura información precisa de productos para tus campañas.
Crea, modifica, pausa y elimina campañas programáticamente. Establece presupuestos, parámetros de targeting y estrategias de puja para Listings Patrocinados y Banners.
Recupera datos de rendimiento en tiempo real incluyendo impresiones, clics, conversiones, métricas de ROAS y gasto publicitario. Genera reportes personalizados con rangos de fechas y selecciones de métricas específicas.
Rastrea saldos de cuenta, visualiza historial de transacciones y gestiona la facturación programáticamente. Implementa algoritmos personalizados de asignación de presupuesto basados en métricas de rendimiento.

​
Autenticación

Todas las solicitudes de la API de Toppie requieren autenticación usando claves de API con autenticación basada en tokens. Esto garantiza un acceso seguro a tus campañas y datos.

​
Obtener tu Clave de API

1

Navegar a Configuración

Accede a Configuración en la navegación de tu dashboard de Toppie
2

Seleccionar Integración de API

Elige Integración de API del menú de navegación izquierdo
3

Crear Nueva Clave

Haz clic en el botón ”+ Nueva Clave de API” para generar una nueva clave
4

Guardar Inmediatamente

Copia y guarda tu clave de API inmediatamente—solo se mostrará una vez por razones de seguridad

​
Usar tu Clave de API

Incluye tu clave de API en el encabezado Authorization de cada solicitud: 
curl -X GET "https://api.topsort.com/toppie/v1/campaigns" \
  -H "Authorization: Bearer TU_CLAVE_API" \
  -H "Content-Type: application/json"

​
Mejores Prácticas de Seguridad

Pautas de Seguridad:
  • Nunca compartas claves de API en repositorios de código o canales públicos
  • Rota las claves regularmente para mayor seguridad
  • Usa variables de entorno o bóvedas seguras para almacenar claves
  • Monitorea el uso de la API para detectar actividad inusual
  • Implementa controles de acceso apropiados en tus aplicaciones

​
Casos de Uso Comunes

Automatiza la creación de campañas, ajustes de presupuesto y optimización de rendimiento basados en reglas y desencadenadores predefinidos. Crea flujos de trabajo que respondan a umbrales de rendimiento o condiciones del mercado.Escenarios de ejemplo:
  • Pausar automáticamente campañas cuando el ROAS cae por debajo del objetivo
  • Crear nuevas campañas basadas en actualizaciones del catálogo de productos
  • Ajustar pujas dinámicamente según la hora del día o niveles de inventario

​
Documentación de la API

Para documentación completa de referencia de la API incluyendo especificaciones de endpoints, parámetros, ejemplos de solicitud/respuesta y pautas de manejo de errores, visita la Referencia de la API de Toppie.

¿Necesitas ayuda con tu integración de Topsort?

Habla con nosotros, el equipo de ingeniería de integraciones.Contáctanos a través de tu canal de mensajería dedicado o en support@topsort.com.Si aún no eres cliente, agenda una demo con nuestro equipo de ventas.