Passer au contenu principal
Les clés API permettent un accès programmé et sécurisé à la plateforme de médias retail unifiée de Toppie. Que vous automatisiez la gestion de campagnes, construisiez des tableaux de bord personnalisés ou intégriez les données Toppie dans des flux de travail existants, les clés API constituent la base pour faire évoluer les opérations de médias retail au-delà de l’interface utilisateur.
Les clés API Toppie fournissent une authentification sécurisée basée sur des jetons pour un accès programmé à tous les points de terminaison Toppie. Cela permet l’automatisation de la gestion de campagnes, l’intégration de données et les flux de travail de rapports personnalisés.

Avantages Clés

Automatiser les Opérations de Campagne

Créez des flux de travail qui créent, gèrent et optimisent les campagnes sur plusieurs détaillants sans intervention manuelle

Intégrations Personnalisées

Connectez les données Toppie aux outils BI, tableaux de bord de rapports ou systèmes internes pour des analyses de médias retail unifiées

Contrôle d'Accès Sécurisé

Les permissions basées sur les rôles garantissent que les membres de l’équipe n’accèdent qu’aux données et capacités dont ils ont besoin

Création de Clés API

1

Accéder aux 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 à 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é
5

Stockage Sécurisé

Stockez votre clé API dans un emplacement sécurisé tel qu’un gestionnaire de mots de passe ou un système de gestion de secrets
Interface d'intégration API Toppie montrant le bouton Nouvelle Clé API

Utilisation des Clés API

Incluez votre clé API dans les en-têtes de requête pour l’authentification lors des appels à l’API Toppie.

En-tête d’Authentification

curl -X GET https://api.topsort.com/toppie/v1/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

Points de Terminaison API Disponibles

Accédez à des fonctionnalités complètes via l’API Toppie :
  • Gestion du Catalogue de Produits - Télécharger, mettre à jour et gérer les catalogues de produits
  • Opérations du Cycle de Vie des Campagnes - Créer, modifier et surveiller les campagnes
  • Analyses et Rapports Avancés - Accéder aux données de performance détaillées
  • Gestion du Budget et des Enchères - Allocation budgétaire et optimisation programmatiques

Documentation API

Pour la documentation de référence API complète, visitez la Référence API Toppie. La documentation inclut :
  • Spécifications et paramètres des points de terminaison
  • Exemples de requêtes/réponses
  • Directives de gestion des erreurs
  • Informations sur les limites de taux
  • Exemples de SDK dans plusieurs langages

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
  • Faites pivoter les clés régulièrement 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 toute activité inhabituelle
  • Implémentez des contrôles d’accès appropriés dans vos applications

Gestion des Clés

  • Régénération - Faites pivoter les clés API périodiquement ou lorsque des membres de l’équipe partent
  • Surveillance - Suivez les modèles d’utilisation de l’API et configurez des alertes pour toute activité inhabituelle
  • Contrôle d’Accès - Limitez l’accès aux clés API uniquement aux membres de l’équipe nécessaires
  • Stockage de Sauvegarde - Stockez les clés dans plusieurs emplacements sécurisés avec des contrôles d’accès appropriés

Cas d’Usage Courants

Automatisation de Campagnes

Automatisez la création de campagnes, les ajustements budgétaires et l’optimisation des performances basés sur des règles et déclencheurs prédéfinis.

Intégration de Rapports

Récupérez les données de performance Toppie dans les outils de business intelligence existants ou les tableaux de bord personnalisés pour des rapports unifiés.

Gestion d’Inventaire

Synchronisez automatiquement les catalogues de produits et maintenez un inventaire à jour chez tous les partenaires retail.

Optimisation Budgétaire

Implémentez des algorithmes personnalisés d’allocation budgétaire basés sur les métriques de performance et les objectifs commerciaux.

Pour obtenir de l’aide sur l’intégration API ou pour discuter de cas d’usage avancés de gestion de campagnes programmatiques, contactez votre gestionnaire de compte Toppie.

Last updated: