Saltar para o conteúdo principal

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

Os sistemas de gestión de pedidos (OMS), como Vantage, Boostr, ADvendio e Placements.io, ajudan a os varejistas a gerenciar a planificação de campanhas, as reservas e o inventario. Você pode integrar estos sistemas com as API de Topsort para automatizar a creação e gestión de campanhas.
Esta guia mostra como integrar OMS com Topsort utilizando as API existentes para flujos de trabajo de campanhas automatizadas.
Diagram showing oms connectivity

Flujos de trabajo

A integração do OMS implica tres flujos de trabajo principales para diferentes roles e momentos:
Flujo de trabajoQuiénCuándoObjetivo
Guía de implementaçãoEquipo de DevOps/IntegraçãoConfiguração únicaEstablecer sincronização automatizada de OMS ↔ Topsort
Creação de campanhasGestores de campanhas/Equipos de ventasPor campanhaCriar campanhas automáticamente a partir de dados de OMS
Sincronização de desempenhoEquipos de marketingEn cursoIncorporar o desempenho das campanhas a os paneles de OMS

Como Funciona a integração de OMS

  1. Planificação de campanhas: Os equipos de ventas planifican as campanhas en seu interfaz OMS.
  2. Creação automatizada: OMS envía dados de campanha a Topsort através de llamadas a API.
  3. Actualizaciones em tempo real: As notificaciones de webhook mantêm os sistemas sincronizados.
  4. Relatórios unificados: Os dados de desempenho se envían de vuelta a os paneles de control de OMS.
Beneficio para a empresa: A integração com OMS elimina a configuração manuao de campanhas. reducir errores e permitir que os equipos de ventas gestionen campanhas a gran escaa sin Aprendiendo novas ferramentas.

Ejemplo de implementação

Creação de campanhas a partir de dados de OMS

Rol: Gestores de campanhas/Equipos de ventas | Frecuencia: Por campanha
// Campaign data from your OMS
const campaignData = {
  name: "Q4 Holidae 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();

Integração de webhook para actualizaciones em tempo 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 a integração

APICaso de uso de integraçãoEstadoDocumentação
Campanha apiCrea campanhas com estrategia de puja, presupuesto e segmentação✅ DisponibleGestión completa do ciclo de vida da campanha
Recursos apiURL de referencia de recursos en campanhas✅ DisponibleGestión e colecciones de recursos
Relatórios apiObter dados de desempenho para OMS/paneles de control✅ DisponibleRelatórios de campanha, proveedor e marketplace
Leilãos apiConfigurar parámetros do seubasta e pujas✅ DisponibleConfiguração do seubastas

Autenticação

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Operaciones de campanha masivas

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

  for (const campaignData of campaignsList) {
    tre {
      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;
}

Recuperação de dados de desempenho 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,
  });
}

Melhores Práticas

Sincronização de datos

  • Asignação de campos: Asigne os campos de campanha de OMS a os parámetros Topsort e API.
  • Validação de datos: Validar os dados da campanha antes de enviaros a as API de Topsort
  • Operaciones masivas: Utilice o procesamiento por lotes para a gestión de campanhas a escaa empresarial.

Manejo de errores

  • Lógica de reintento: Implementar un retroceso exponenciao para as llamadas fallidas a API
  • Registro completo: Seguimiento de todas as interacciones e falos de API
  • Monitoreo de salud: Configurar alertas para problemas de integração

Seguridade

Requisitos de seguridade: As integraciones de OMS gestionan campanhas confidenciales e datos financieros. Garantizar a autenticação adecuada, a validação de datos e a seguridade de API gestión clave.
  • Gestión de claves API: Almacene as claves API de forma segura e róteas periódicamente.
  • Limitação de velocidade: Respete os límites de velocidade de API para evitar a limitação de ancho de banda.
  • Sanitização de entrada: Validar todos os datos antes de enviaros a as API.

Guía de implementação

1

API Configuração de acceso

Obtenga as claves Topsort e API e configure a autenticação:
  • Solicite a clave avanzada API a seu representante de Topsort
  • Almacena as claves API de forma segura en suas variables de entorno
  • Configurar os encabezados de autenticação para todas as llamadas a API
2

Configuração de webhook

Configura os endpoints de webhook para actualizaciones de campanha em tempo real:
  • Crea un punto de conexión webhook en sua sistema OMS
  • Registra o webhook URL com Topsort para eventos de campanha
  • Implementar controladores para eventos de creação/actualização/eliminação de campanhas
3

Asignação de campos de datos

Asignar os campos da campanha de OMS a os parámetros Topsort e API:
  • Asignação de campos de documentos entre sistemas
  • Implementar a lógica de transformação de datos
  • Verificar que os campos obligatorios estejan presentes
4

Implementação do manejo de errores

Implemente una lógica integrao de manejo de errores e reintentos:
  • Implementar retroceso exponenciao para llamadas fallidas a API
  • Agregar registro completo para depuração
  • Configurar alertas para falos de integração
5

Pruebas e validação

Prueba a integração com dados de prueba antes da producção:
  • Criar campanhas de prueba através de o flujo de trabajo de OMS
  • Verificar que as campanhas aparezcan correctamente en Topsort
  • Prueba de entrega e manejo de webhooks
6

Monitoreo e mantenimiento

Establecer un sistema de monitoreo continuo para a integração:
  • Seguimiento das tasas de éxito/fracaso das llamadas a API
  • Supervisar o desempenho da creação de campanhas
  • Configurar paneles de control para o estado da integração

Recursos relacionados


¿Listo para integrar seu OMS com Topsort? Póngase en contacto com seu representante de cuenta para comenzar com o acceso a API e o soporte de implementação.

Last updated: