Passer au contenu principal
Topsort utilise deux types de clés API pour différents objectifs.

Référence Rapide

Type de CléObjectifUtilisateur
Marketplace API KeyParamètres AdminToutes les opérations du marketplaceServeurs backend
Advanced API KeyTableau de Bord VendeurCampagnes d’un seul vendeurOutils vendeur

Quelle Clé Ai-Je Besoin ?

EndpointType de Clé
POST /v2/auctionsMarketplace
POST /v2/eventsMarketplace
POST /v2/productsMarketplace
GET /public/v1/reporting-service/*Marketplace
POST /public/v1/campaign-service/*L’une ou l’autre (limitée au vendeur si clé Advanced)
GET /public/v1/billing-service/*Marketplace

Erreurs Courantes

401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}
Causes :
  • Clé API non incluse dans l’en-tête Authorization
  • La clé est mal formée ou expirée
  • Utilisation d’une clé Advanced sur un endpoint exclusif au Marketplace
Solution : Vérifiez le format de l’en-tête : Authorization: Bearer YOUR_API_KEY

403 Forbidden

{
  "error": "Forbidden",
  "message": "Insufficient permissions"
}
Causes :
  • Utilisation d’une clé Advanced pour un endpoint nécessitant une clé Marketplace
  • La clé Advanced tente d’accéder aux données d’un autre vendeur
Solution : Utilisez la clé API Marketplace pour les opérations inter-vendeurs

Comment Obtenir Vos Clés

Marketplace API Key

1

Accéder à Topsort Admin

Connectez-vous à votre tableau de bord d’administration Topsort
2

Naviguer vers les Paramètres API

Allez dans ParamètresIntégration API
3

Créer une Clé API

Cliquez sur “Générer une clé API” et sélectionnez “Marketplace API key”
4

Copier et Stocker

Copiez immédiatement la clé et stockez-la en toute sécurité (elle n’est affichée qu’une seule fois)

Advanced API Key

1

Accéder au Tableau de Bord Vendeur

Connectez-vous à votre Tableau de Bord d’Administration Topsort
2

Naviguer vers les Paramètres API

Allez dans ParamètresAccès API
3

Générer une Clé

Cliquez sur “Générer une Clé” pour créer votre clé Advanced API
4

Copier et Stocker

Copiez la clé et stockez-la en toute sécurité dans vos variables d’environnement

Meilleures Pratiques de Sécurité

  • Ne jamais valider les clés dans le contrôle de version
  • Stocker les clés dans des variables d’environnement
  • Faire pivoter les clés régulièrement
  • Utiliser différentes clés pour différents environnements (dev, staging, production)
  • Restreindre l’accès aux clés uniquement aux membres nécessaires de l’équipe

Portée des Permissions de Clé

Marketplace API Key

  • Accès complet à toutes les opérations du marketplace
  • Peut créer et gérer des campagnes pour n’importe quel vendeur
  • Accès à toutes les données de reporting
  • Requise pour les endpoints d’enchère et d’événement

Advanced API Key

  • Limitée aux données d’un vendeur spécifique
  • Peut uniquement gérer les campagnes pour le vendeur associé
  • Ne peut pas accéder aux informations d’autres vendeurs
  • Idéale pour les intégrations spécifiques au vendeur
Last updated: