Zum Hauptinhalt springen
Die Toppie API ermöglicht sicheren programmatischen Zugriff auf die einheitliche Retail-Media-Plattform von Topsort. Ob Sie das Kampagnenmanagement automatisieren, benutzerdefinierte Dashboards erstellen oder Toppie-Daten in bestehende Workflows integrieren - die API bietet die Grundlage für die Skalierung von Retail-Media-Operationen über die Benutzeroberfläche hinaus.
Die Toppie API bietet öffentliche Endpunkte zur Verwaltung und Analyse von Agenturkonten, Kampagnen und Finanzaktivitäten über mehrere Einzelhandelspartner hinweg.

Toppie API-Referenz

Vollständige API-Dokumentation mit allen verfügbaren Endpunkten anzeigen

​
Hauptvorteile

  • Kampagnenoperationen automatisieren - Erstellen Sie Workflows zur Verwaltung von Kampagnen über Einzelhändler hinweg ohne manuelle Eingriffe
  • Benutzerdefinierte Integrationen - Verbinden Sie Toppie-Daten mit BI-Tools und internen Systemen
  • Sichere Zugriffskontrolle - Rollenbasierte Berechtigungen für Daten und Funktionen

​
API-Funktionen

Die Toppie API bietet umfassende Funktionalität über die folgenden Endpunkte:
Laden Sie Produktkataloge hoch, aktualisieren und verwalten Sie sie bei Einzelhandelspartnern. Halten Sie das Inventar synchron und stellen Sie genaue Produktinformationen für Ihre Kampagnen sicher.
Erstellen, ändern, pausieren und löschen Sie Kampagnen programmatisch. Legen Sie Budgets, Targeting-Parameter und Gebotsstrategien für Sponsored Listings und Banner fest.
Rufen Sie Echtzeit-Leistungsdaten ab, einschließlich Impressionen, Klicks, Conversions, ROAS-Metriken und Werbeausgaben. Generieren Sie benutzerdefinierte Berichte mit spezifischen Datumsbereichen und Metrikauswahlen.
Verfolgen Sie Kontostände, sehen Sie Transaktionsverläufe ein und verwalten Sie die Abrechnung programmatisch. Implementieren Sie benutzerdefinierte Budgetzuteilungsalgorithmen basierend auf Leistungsmetriken.

​
Authentifizierung

Alle Toppie API-Anfragen erfordern eine Authentifizierung mit API-Schlüsseln und tokenbasierter Authentifizierung. Dies gewährleistet sicheren Zugriff auf Ihre Kampagnen und Daten.

​
Ihren API-Schlüssel erhalten

1

Zu Einstellungen navigieren

Greifen Sie auf Einstellungen in der Navigation Ihres Toppie-Dashboards zu
2

API-Integration auswählen

Wählen Sie API-Integration aus dem linken Navigationsmenü
3

Neuen Schlüssel erstellen

Klicken Sie auf die Schaltfläche ”+ Neuer API-Schlüssel”, um einen neuen Schlüssel zu generieren
4

Sofort speichern

Kopieren und speichern Sie Ihren API-Schlüssel sofort—er wird aus Sicherheitsgründen nur einmal angezeigt

​
Ihren API-Schlüssel verwenden

Fügen Sie Ihren API-Schlüssel in den Authorization-Header jeder Anfrage ein: 
curl -X GET "https://api.topsort.com/toppie/v1/campaigns" \
  -H "Authorization: Bearer IHR_API_SCHLÜSSEL" \
  -H "Content-Type: application/json"

​
Best Practices für Sicherheit

Sicherheitsrichtlinien:
  • Teilen Sie API-Schlüssel niemals in Code-Repositories oder öffentlichen Kanälen
  • Rotieren Sie Schlüssel regelmäßig für erhöhte Sicherheit
  • Verwenden Sie Umgebungsvariablen oder sichere Tresore zum Speichern von Schlüsseln
  • Überwachen Sie die API-Nutzung auf ungewöhnliche Aktivitäten
  • Implementieren Sie geeignete Zugriffskontrollen in Ihren Anwendungen

​
Häufige Anwendungsfälle

Automatisieren Sie die Kampagnenerstellung, Budgetanpassungen und Leistungsoptimierung basierend auf vordefinierten Regeln und Auslösern. Erstellen Sie Workflows, die auf Leistungsschwellen oder Marktbedingungen reagieren.Beispielszenarien:
  • Kampagnen automatisch pausieren, wenn der ROAS unter das Ziel fällt
  • Neue Kampagnen basierend auf Produktkatalog-Updates erstellen
  • Gebote dynamisch anpassen basierend auf Tageszeit oder Lagerbeständen

​
API-Dokumentation

Für vollständige API-Referenzdokumentation einschließlich Endpunktspezifikationen, Parametern, Anfrage-/Antwortbeispielen und Fehlerbehandlungsrichtlinien besuchen Sie die Toppie API-Referenz.
Agustin - Integrations Team MemberAmelia - Integrations Team MemberBernardita - Integrations Team MemberBorumy - Integrations Team MemberFelipe - Integrations Team MemberGui - Integrations Team MemberJaviera - Integrations Team MemberLinn - Integrations Team MemberMarcio - Integrations Team MemberMateus - Integrations Team MemberMax - Integrations Team MemberRodrigo - Integrations Team Member

Brauchen Sie Hilfe bei Ihrer Topsort-Integration?

Sprechen Sie mit uns, dem Integrations-Engineering-Team.Erreichen Sie uns über Ihren dedizierten Nachrichtenkanal oder unter support@topsort.com.Falls Sie noch kein Kunde sind, buchen Sie eine Demo mit unserem Vertriebsteam.