Saltar al contenido principal

Conexión de Topsort con sistemas de gestión de pedidos

Los sistemas de gestión de pedidos (OMS), como Vantage, Boostr, ADvendio y Placements.io, ayudan a los minoristas a gestionar la planificación de campañas, las reservas y el inventario. Puede integrar estos sistemas con las API de Topsort para automatizar la creación y gestión de campañas.
Esta guía muestra cómo integrar OMS con Topsort utilizando las API existentes para flujos de trabajo de campañas automatizadas.
Diagram showing oms connectivity

Flujos de trabajo

La integración del OMS implica tres flujos de trabajo principales para diferentes roles y momentos:
Flujo de trabajoQuiénCuándoObjetivo
Guía de implementaciónEquipo de DevOps/IntegraciónConfiguración únicaEstablecer sincronización automatizada de OMS ↔ Topsort
Creación de campañasGestores de campañas/Equipos de ventasPor campañaCrear campañas automáticamente a partir de datos de OMS
Sincronización de rendimientoEquipos de marketingEn cursoIncorporar el rendimiento de las campañas a los paneles de OMS

Cómo funciona la integración de OMS

  1. Planificación de campañas: Los equipos de ventas planifican las campañas en su interfaz OMS.
  2. Creación automatizada: OMS envía datos de campaña a Topsort mediante llamadas a API.
  3. Actualizaciones en tiempo real: Las notificaciones de webhook mantienen los sistemas sincronizados.
  4. Informes unificados: Los datos de rendimiento se envían de vuelta a los paneles de control de OMS.
Beneficio para la empresa: La integración con OMS elimina la configuración manual de campañas. reducir errores y permitir que los equipos de ventas gestionen campañas a gran escala sin Aprendiendo nuevas herramientas.

Ejemplo de implementación

Creación de campañas a partir de datos de OMS

Rol: Gestores de campañas/Equipos de ventas | Frecuencia: Por campaña
// Campaign data from your OMS
const campaignData = {
  name: "Q4 Holiday Campaign - Brand X",
  budget: 15000,
  startDate: "2024-11-01",
  endDate: "2024-12-31",
  biddingStrategy: "target_roas",
  targetRoas: 4.5,
  vendorId: "vendor-123",
};

// Create campaign in Topsort
const response = await fetch("https://api.topsort.com/v2/campaigns", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: campaignData.name,
    type: "sponsored_products",
    vendor_id: campaignData.vendorId,
    bidding_strategy: campaignData.biddingStrategy,
    target_roas: campaignData.targetRoas,
    budget: {
      amount: campaignData.budget,
      currency: "USD",
      period: "lifetime",
    },
    start_date: campaignData.startDate,
    end_date: campaignData.endDate,
  }),
});

const campaign = await response.json();

Integración de webhook para actualizaciones en tiempo real

// Set up webhook to receive campaign updates
const webhookPayload = {
  url: "https://your-oms.com/webhooks/topsort",
  events: ["campaign:create", "campaign:update", "campaign:delete"],
};

await fetch("https://api.topsort.com/v2/webhooks", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(webhookPayload),
});

// Handle webhook in your OMS
app.post("/webhooks/topsort", (req, res) => {
  const { channel, payload } = req.body;

  switch (channel) {
    case "campaign:create":
      updateOMSCampaignStatus(payload.campaign_id, "active");
      break;
    case "campaign:update":
      syncCampaignData(payload);
      break;
  }

  res.status(200).send("OK");
});

Referencia API

API Topsort actuales para la integración

APICaso de uso de integraciónEstadoDocumentación
Campaña apiCrea campañas con estrategia de puja, presupuesto y segmentación✅ DisponibleGestión completa del ciclo de vida de la campaña
Recursos apiURL de referencia de recursos en campañas✅ DisponibleGestión y colecciones de recursos
Informes apiObtener datos de rendimiento para OMS/paneles de control✅ DisponibleInformes de campaña, proveedor y marketplace
Subastas apiConfigurar parámetros de subasta y pujas✅ DisponibleConfiguración de subastas

Autenticación

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Operaciones de campaña masivas

// Create multiple campaigns from OMS batch
async function createBulkCampaigns(campaignsList) {
  const results = [];

  for (const campaignData of campaignsList) {
    try {
      const response = await fetch("https://api.topsort.com/v2/campaigns", {
        method: "POST",
        headers: {
          Authorization: "Bearer YOUR_API_KEY",
          "Content-Type": "application/json",
        },
        body: JSON.stringify(campaignData),
      });

      const campaign = await response.json();
      results.push({ success: true, campaign });
    } catch (error) {
      results.push({ success: false, error: error.message });
    }
  }

  return results;
}

Recuperación de datos de rendimiento para paneles de control de OMS

Rol: Equipos de Marketing | Frecuencia: Continua/Programada
// Pull campaign performance back to OMS
async function syncPerformanceData(campaignId) {
  const reportResponse = await fetch(
    `https://api.topsort.com/v2/reports/campaigns/${campaignId}`,
    {
      method: "GET",
      headers: {
        Authorization: "Bearer YOUR_API_KEY",
      },
    }
  );

  const performanceData = await reportResponse.json();

  // Update OMS dashboard with performance metrics
  await updateOMSDashboard(campaignId, {
    impressions: performanceData.impressions,
    clicks: performanceData.clicks,
    spend: performanceData.spend,
    conversions: performanceData.conversions,
  });
}

Mejores prácticas

Sincronización de datos

  • Asignación de campos: Asigne los campos de campaña de OMS a los parámetros Topsort y API.
  • Validación de datos: Validar los datos de la campaña antes de enviarlos a las API de Topsort
  • Operaciones masivas: Utilice el procesamiento por lotes para la gestión de campañas a escala empresarial.

Manejo de errores

  • Lógica de reintento: Implementar un retroceso exponencial para las llamadas fallidas a API
  • Registro completo: Seguimiento de todas las interacciones y fallos de API
  • Monitoreo de salud: Configurar alertas para problemas de integración

Seguridad

Requisitos de seguridad: Las integraciones de OMS gestionan campañas confidenciales y datos financieros. Garantizar la autenticación adecuada, la validación de datos y la seguridad de API gestión clave.
  • Gestión de claves API: Almacene las claves API de forma segura y rótelas periódicamente.
  • Limitación de velocidad: Respete los límites de velocidad de API para evitar la limitación de ancho de banda.
  • Sanitización de entrada: Validar todos los datos antes de enviarlos a las API.

Guía de implementación

1

API Configuración de acceso

Obtenga las claves Topsort y API y configure la autenticación:
  • Solicite la clave avanzada API a su representante de Topsort
  • Almacena las claves API de forma segura en tus variables de entorno
  • Configurar los encabezados de autenticación para todas las llamadas a API
2

Configuración de webhook

Configura los endpoints de webhook para actualizaciones de campaña en tiempo real:
  • Crea un punto de conexión webhook en tu sistema OMS
  • Registra el webhook URL con Topsort para eventos de campaña
  • Implementar controladores para eventos de creación/actualización/eliminación de campañas
3

Asignación de campos de datos

Asignar los campos de la campaña de OMS a los parámetros Topsort y API:
  • Asignación de campos de documentos entre sistemas
  • Implementar la lógica de transformación de datos
  • Verificar que los campos obligatorios estén presentes
4

Implementación del manejo de errores

Implemente una lógica integral de manejo de errores y reintentos:
  • Implementar retroceso exponencial para llamadas fallidas a API
  • Agregar registro completo para depuración
  • Configurar alertas para fallos de integración
5

Pruebas y validación

Prueba la integración con datos de prueba antes de la producción:
  • Crear campañas de prueba mediante el flujo de trabajo de OMS
  • Verificar que las campañas aparezcan correctamente en Topsort
  • Prueba de entrega y manejo de webhooks
6

Monitoreo y mantenimiento

Establecer un sistema de monitoreo continuo para la integración:
  • Seguimiento de las tasas de éxito/fracaso de las llamadas a API
  • Supervisar el rendimiento de la creación de campañas
  • Configurar paneles de control para el estado de la integración

Recursos relacionados


¿Listo para integrar su OMS con Topsort? Póngase en contacto con su representante de cuenta para comenzar con el acceso a API y el soporte de implementación.

Last updated: