Passer au contenu principal
L’API Toppie permet un accès programmatique sécurisé à la plateforme unifiée de retail media de Topsort. Que vous automatisiez la gestion de campagnes, créiez des tableaux de bord personnalisés ou intégriez des données Toppie dans des flux de travail existants, l’API fournit la base pour faire évoluer les opérations de retail media au-delà de l’interface utilisateur.
L’API Toppie fournit des endpoints publics pour gérer et analyser les comptes d’agence, les campagnes et l’activité financière sur plusieurs partenaires de distribution.

Référence de l'API Toppie

Consultez la documentation complète de l’API avec tous les endpoints disponibles

​
Avantages Clés

  • Automatiser les Opérations de Campagne - Créez des flux de travail pour gérer les campagnes sur les distributeurs sans intervention manuelle
  • Intégrations Personnalisées - Connectez les données Toppie aux outils de BI et aux systèmes internes
  • Contrôle d’Accès Sécurisé - Permissions basées sur les rôles pour les données et les capacités

​
Capacités de l’API

L’API Toppie offre des fonctionnalités complètes via les endpoints suivants :
Téléchargez, mettez à jour et gérez les catalogues de produits chez les partenaires de distribution. Maintenez l’inventaire synchronisé et assurez des informations produit précises pour vos campagnes.
Créez, modifiez, mettez en pause et supprimez des campagnes de manière programmatique. Définissez les budgets, les paramètres de ciblage et les stratégies d’enchères pour les Listings Sponsorisés et les Bannières.
Récupérez les données de performance en temps réel incluant les impressions, les clics, les conversions, les métriques de ROAS et les dépenses publicitaires. Générez des rapports personnalisés avec des plages de dates et des sélections de métriques spécifiques.
Suivez les soldes de compte, consultez l’historique des transactions et gérez la facturation de manière programmatique. Implémentez des algorithmes personnalisés d’allocation de budget basés sur les métriques de performance.

​
Authentification

Toutes les requêtes de l’API Toppie nécessitent une authentification utilisant des clés API avec authentification basée sur des tokens. Cela garantit un accès sécurisé à vos campagnes et données.

​
Obtenir votre Clé API

1

Naviguer vers Paramètres

Accédez aux Paramètres dans la navigation de votre tableau de bord Toppie
2

Sélectionner Intégration API

Choisissez Intégration API dans le menu de navigation de gauche
3

Créer une Nouvelle Clé

Cliquez sur le bouton ”+ Nouvelle Clé API” pour générer une nouvelle clé
4

Sauvegarder Immédiatement

Copiez et sauvegardez votre clé API immédiatement—elle ne sera affichée qu’une seule fois pour des raisons de sécurité

​
Utiliser votre Clé API

Incluez votre clé API dans l’en-tête Authorization de chaque requête : 
curl -X GET "https://api.topsort.com/toppie/v1/campaigns" \
  -H "Authorization: Bearer VOTRE_CLE_API" \
  -H "Content-Type: application/json"

​
Meilleures Pratiques de Sécurité

Directives de Sécurité :
  • Ne partagez jamais les clés API dans les dépôts de code ou les canaux publics
  • Effectuez une rotation régulière des clés pour une sécurité accrue
  • Utilisez des variables d’environnement ou des coffres-forts sécurisés pour stocker les clés
  • Surveillez l’utilisation de l’API pour détecter toute activité inhabituelle
  • Implémentez des contrôles d’accès appropriés dans vos applications

​
Cas d’Usage Courants

Automatisez la création de campagnes, les ajustements de budget et l’optimisation des performances basés sur des règles et des déclencheurs prédéfinis. Créez des flux de travail qui répondent aux seuils de performance ou aux conditions du marché.Scénarios d’exemple :
  • Mettre automatiquement en pause les campagnes lorsque le ROAS tombe en dessous de la cible
  • Créer de nouvelles campagnes basées sur les mises à jour du catalogue de produits
  • Ajuster dynamiquement les enchères en fonction de l’heure de la journée ou des niveaux d’inventaire

​
Documentation de l’API

Pour la documentation complète de référence de l’API incluant les spécifications des endpoints, les paramètres, les exemples de requête/réponse et les directives de gestion des erreurs, visitez la Référence de l’API Toppie.

Besoin d'aide avec votre intégration Topsort ?

Parlez-nous, l'équipe d'ingénierie des intégrations.Contactez-nous via votre canal de messagerie dédié ou à support@topsort.com.Si vous n'êtes pas encore client, planifiez une démo avec notre équipe de vente.