Sistemas de gestão de pedidos

Conecte as APIs Topsort com os sistemas de gestão de pedidos para a orquestração de campanhas.

​

Conexão de Topsort com sistemas de gestão de pedidos

Os sistemas de gestão de pedidos (OMS), como Vantage, Boostr, ADvendio e Placements.io, ajudam os varejistas a gerenciar o planejamento de campanhas, as reservas e o inventário. Você pode integrar estes sistemas com as APIs de Topsort para automatizar a criação e gestão de campanhas.

Este guia mostra como integrar OMS com Topsort utilizando as APIs existentes para fluxos de trabalho de campanhas automatizadas.

​

Fluxos de trabalho

A integração do OMS envolve três fluxos de trabalho principais para diferentes funções e momentos:

Fluxo de trabalho	Quem	Quando	Objetivo
Guia de implementação	Equipe de DevOps/Integração	Configuração única	Estabelecer sincronização automatizada de OMS ↔ Topsort
Criação de campanhas	Gestores de campanhas/Equipes de vendas	Por campanha	Criar campanhas automaticamente a partir de dados de OMS
Sincronização de desempenho	Equipes de marketing	Em curso	Incorporar o desempenho das campanhas aos painéis de OMS

​

Como funciona a integração de OMS

1. Planejamento de campanhas: As equipes de vendas planejam as campanhas em sua interface OMS.
2. Criação automatizada: OMS envia dados de campanha ao Topsort através de chamadas à API.
3. Atualizações em tempo real: As notificações de webhook mantêm os sistemas sincronizados.
4. Relatórios unificados: Os dados de desempenho são enviados de volta aos painéis de controle de OMS.

Benefício para a empresa: A integração com OMS elimina a configuração manual de campanhas, reduz erros e permite que as equipes de vendas gerenciem campanhas em grande escala sem aprender novas ferramentas.

​

Exemplo de implementação

​

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

Função: Gestores de campanhas/Equipes de vendas | Frequência: Por campanha

// 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();

​

Integração de webhook para atualizações 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");
});

​

Referência da API

​

APIs Topsort atuais para integração

API	Caso de uso de integração	Estado	Documentação
API de Campanhas	Criar campanhas com estratégia de lance, orçamento e segmentação	✅ Disponível	Gestão completa do ciclo de vida da campanha
API de Recursos	URL de referência de recursos em campanhas	✅ Disponível	Gestão e coleções de recursos
API de Relatórios	Obter dados de desempenho para OMS/painéis de controle	✅ Disponível	Relatórios de campanha, fornecedor e marketplace
API de Leilões	Configurar parâmetros de leilão e lances	✅ Disponível	Configuração de leilões

​

Autenticação

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

​

Operações de campanha em massa

// 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;
}

​

Recuperação de dados de desempenho para painéis de controle de OMS

Função: Equipes de Marketing | Frequência: Contínua/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 dados

• Mapeamento de campos: Mapeie os campos de campanha de OMS aos parâmetros da API Topsort.
• Validação de dados: Validar os dados da campanha antes de enviá-los às APIs de Topsort
• Operações em massa: Utilize o processamento em lote para a gestão de campanhas em escala empresarial.

​

Tratamento de erros

• Lógica de nova tentativa: Implementar um recuo exponencial para as chamadas falhadas à API
• Registro completo: Acompanhamento de todas as interações e falhas de API
• Monitoramento de saúde: Configurar alertas para problemas de integração

​

Segurança

Requisitos de segurança: As integrações de OMS gerenciam campanhas confidenciais e dados financeiros. Garantir a autenticação adequada, a validação de dados e a segurança de gestão de chaves API.

• Gestão de chaves API: Armazene as chaves API de forma segura e faça rotação periódica.
• Limitação de taxa: Respeite os limites de taxa de API para evitar a limitação de largura de banda.
• Sanitização de entrada: Validar todos os dados antes de enviá-los às APIs.

​

Guia de implementação

1. Configuração de acesso à API

   Obtenha as chaves da API Topsort e configure a autenticação:

   • Solicite a chave avançada de API ao seu representante de Topsort
   • Armazene as chaves API de forma segura em suas variáveis de ambiente
   • Configure os cabeçalhos de autenticação para todas as chamadas à API
2. Configuração de webhook

   Configure os endpoints de webhook para atualizações de campanha em tempo real:

   • Crie um ponto de conexão webhook em seu sistema OMS
   • Registre a URL do webhook com Topsort para eventos de campanha
   • Implemente manipuladores para eventos de criação/atualização/exclusão de campanhas
3. Mapeamento de campos de dados

   Mapeie os campos da campanha de OMS aos parâmetros da API Topsort:

   • Documente o mapeamento de campos entre sistemas
   • Implemente a lógica de transformação de dados
   • Verifique que os campos obrigatórios estejam presentes
4. Implementação do tratamento de erros

   Implemente uma lógica integrada de tratamento de erros e novas tentativas:

   • Implementar recuo exponencial para chamadas falhadas à API
   • Adicionar registro completo para depuração
   • Configurar alertas para falhas de integração
5. Testes e validação

   Teste a integração com dados de teste antes da produção:

   • Criar campanhas de teste através do fluxo de trabalho de OMS
   • Verificar que as campanhas apareçam corretamente no Topsort
   • Testar entrega e manipulação de webhooks
6. Monitoramento e manutenção

   Estabeleça um sistema de monitoramento contínuo para a integração:

   • Acompanhar as taxas de sucesso/falha das chamadas à API
   • Supervisionar o desempenho da criação de campanhas
   • Configurar painéis de controle para o estado da integração

​

Recursos relacionados

• Guia de integração de DAM - Conectividade de gestão de ativos digitais
• Documentação da API de Campanhas
• Documentação da API de Relatórios

---

Pronto para integrar seu OMS com Topsort? Entre em contato com seu representante de conta para começar com o acesso à API e o suporte de implementação.

---