Zum Hauptinhalt springen

Topsort mit Auftragsverwaltungssystemen verbinden

Auftragsverwaltungssysteme (OMS) wie Vantage, Boostr, ADvendio und Placements.io helfen Einzelhändlern bei der Verwaltung von Kampagnenplanung, Buchung und Inventar. Sie können diese Systeme mit den APIs von Topsort integrieren, um die Erstellung und Verwaltung von Kampagnen zu automatisieren.
Dieser Leitfaden zeigt, wie Sie OMS mit Topsort unter Verwendung bestehender APIs für automatisierte Kampagnen-Workflows integrieren.
Diagramm zur Darstellung der OMS-Konnektivität

Workflows

Die OMS-Integration umfasst drei Haupt-Workflows für unterschiedliche Rollen und Zeitpunkte:
WorkflowWerWannZiel
ImplementierungsleitfadenDevOps/IntegrationsteamEinmalige EinrichtungAutomatisierte OMS ↔ Topsort-Synchronisation einrichten
KampagnenerstellungKampagnenmanager/VertriebsteamsPro KampagneKampagnen automatisch aus OMS-Daten erstellen
LeistungssynchronisationMarketingteamsFortlaufendKampagnenleistung in OMS-Dashboards abrufen

Wie OMS-Integration funktioniert

  1. Kampagnenplanung: Vertriebsteams planen Kampagnen in ihrer OMS-Oberfläche
  2. Automatisierte Erstellung: OMS sendet Kampagnendaten über API-Aufrufe an Topsort
  3. Echtzeit-Updates: Webhook-Benachrichtigungen halten Systeme synchronisiert
  4. Einheitliche Berichterstattung: Leistungsdaten fließen zurück zu OMS-Dashboards
Unternehmensvorteil: Die OMS-Integration eliminiert manuelle Kampagneneinrichtung, reduziert Fehler und ermöglicht Vertriebsteams die Verwaltung von Kampagnen im großen Maßstab ohne neue Tools zu erlernen.

Implementierungsbeispiel

Kampagnenerstellung aus OMS-Daten

Rolle: Kampagnenmanager/Vertriebsteams | Häufigkeit: Pro Kampagne
// Kampagnendaten von Ihrem 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",
};

// Kampagne in Topsort erstellen
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();

Webhook-Integration für Echtzeit-Updates

// Webhook einrichten, um Kampagnen-Updates zu erhalten
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),
});

// Webhook in Ihrem OMS verarbeiten
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");
});

API-Referenz

Aktuelle Topsort-APIs für Integration

APIIntegrations-AnwendungsfallStatusDokumentation
Campaign APIKampagnen mit Gebotsstrategie, Budget, Targeting erstellen✅ VerfügbarVollständiges Kampagnen-Lebenszyklusmanagement
Assets APIAsset-URLs in Kampagnen referenzieren✅ VerfügbarAsset- und Sammlungsverwaltung
Reporting APILeistungsdaten zu OMS/Dashboards abrufen✅ VerfügbarKampagnen-, Anbieter-, Marketplace-Berichte
Auctions APIAuktions- und Gebotsparameter konfigurieren✅ VerfügbarAuktionskonfiguration

Authentifizierung

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Massen-Kampagnenoperationen

// Mehrere Kampagnen aus einem OMS-Batch erstellen
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;
}

Abrufen von Leistungsdaten für OMS-Dashboards

Rolle: Marketingteams | Häufigkeit: Fortlaufend/Geplant
// Kampagnenleistung zu OMS abrufen
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();

  // OMS-Dashboard mit Leistungsmetriken aktualisieren
  await updateOMSDashboard(campaignId, {
    impressions: performanceData.impressions,
    clicks: performanceData.clicks,
    spend: performanceData.spend,
    conversions: performanceData.conversions,
  });
}

Best Practices

Datensynchronisation

  • Feldzuordnung: Ordnen Sie OMS-Kampagnenfelder den Topsort-API-Parametern zu
  • Datenvalidierung: Validieren Sie Kampagnendaten vor dem Senden an Topsort-APIs
  • Massenoperationen: Verwenden Sie Batch-Verarbeitung für unternehmensweites Kampagnenmanagement

Fehlerbehandlung

  • Wiederholungslogik: Implementieren Sie exponentiellen Backoff für fehlgeschlagene API-Aufrufe
  • Umfassende Protokollierung: Verfolgen Sie alle API-Interaktionen und -Fehler
  • Gesundheitsüberwachung: Richten Sie Benachrichtigungen für Integrationsprobleme ein

Sicherheit

Sicherheitsanforderungen: OMS-Integrationen verarbeiten sensible Kampagnen- und Finanzdaten. Gewährleisten Sie ordnungsgemäße Authentifizierung, Datenvalidierung und sichere API-Schlüsselverwaltung.
  • API-Schlüsselverwaltung: Speichern Sie API-Schlüssel sicher und rotieren Sie sie regelmäßig
  • Rate Limiting: Beachten Sie API-Rate-Limits, um Throttling zu vermeiden
  • Eingabebereinigung: Validieren Sie alle Daten vor dem Senden an APIs

Implementierungsleitfaden

1

API-Zugriff einrichten

Erhalten Sie Topsort-API-Schlüssel und konfigurieren Sie die Authentifizierung:
  • Fordern Sie einen erweiterten API-Schlüssel von Ihrem Topsort-Vertreter an
  • Speichern Sie API-Schlüssel sicher in Ihren Umgebungsvariablen
  • Konfigurieren Sie Authentifizierungs-Header für alle API-Aufrufe
2

Webhooks konfigurieren

Richten Sie Webhook-Endpunkte für Echtzeit-Kampagnen-Updates ein:
  • Erstellen Sie einen Webhook-Endpunkt in Ihrem OMS-System
  • Registrieren Sie die Webhook-URL bei Topsort für Kampagnenereignisse
  • Implementieren Sie Handler für Kampagnenerstellungs-/Aktualisierungs-/Löschereignisse
3

Datenfeldzuordnung

Ordnen Sie OMS-Kampagnenfelder den Topsort-API-Parametern zu:
  • Dokumentieren Sie Feldzuordnungen zwischen Systemen
  • Implementieren Sie Datentransformationslogik
  • Validieren Sie, dass erforderliche Felder vorhanden sind
4

Fehlerbehandlung implementieren

Erstellen Sie umfassende Fehlerbehandlung und Wiederholungslogik:
  • Implementieren Sie exponentiellen Backoff für fehlgeschlagene API-Aufrufe
  • Fügen Sie umfassende Protokollierung für Debugging hinzu
  • Richten Sie Benachrichtigungen für Integrationsfehler ein
5

Tests und Validierung

Testen Sie die Integration mit Sandbox-Daten vor der Produktion:
  • Erstellen Sie Test-Kampagnen über den OMS-Workflow
  • Überprüfen Sie, dass Kampagnen korrekt in Topsort erscheinen
  • Testen Sie Webhook-Zustellung und -Verarbeitung
6

Überwachung und Wartung

Richten Sie kontinuierliche Überwachung für die Integration ein:
  • Verfolgen Sie Erfolgs-/Fehlerquoten von API-Aufrufen
  • Überwachen Sie die Leistung der Kampagnenerstellung
  • Richten Sie Dashboards für Integrationsgesundheit ein

Verwandte Ressourcen


Bereit, Ihr OMS mit Topsort zu integrieren? Kontaktieren Sie Ihren Account-Vertreter, um mit API-Zugriff und Implementierungsunterstützung zu beginnen.

Zuletzt aktualisiert: