Topsort utilise deux types de clés API pour différents objectifs.
Référence Rapide
| Type de Clé | Objectif |
|---|
| Marketplace API Key | Endpoints d’enchère et d’événement |
| Advanced API Key | Synchronisation de catalogue, campagnes, reporting, facturation |
La plupart des intégrations nécessitent les deux types de clé : une clé Advanced pour la synchronisation de catalogue, les campagnes et le reporting, et une clé Marketplace pour les enchères et les événements.
Quelle Clé Ai-Je Besoin ?
| Endpoint | Type de Clé |
|---|
POST /v2/auctions | Marketplace |
POST /v2/events | Marketplace |
/public/v1/catalog-search-service/* | Advanced |
/public/v1/campaign-service/* | Advanced |
/public/v1/reporting-service/* | Advanced |
/public/v1/billing-service/* | Advanced |
Erreurs Courantes
401 Unauthorized
{
"error": "Unauthorized",
"message": "Invalid or missing API key"
}
- 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"
}
- Utilisation d’une clé Advanced sur un endpoint qui nécessite une clé Marketplace
- Utilisation d’une clé Marketplace sur un endpoint qui nécessite une clé Advanced
Solution : Utilisez le type de clé qui correspond à l’endpoint — consultez Quelle Clé Ai-Je Besoin ? ci-dessus
Marketplace API Key
Accéder à Topsort Admin
Connectez-vous à votre tableau de bord d’administration Topsort
Naviguer vers les Paramètres API
Allez dans Paramètres → Intégration API
Créer une Clé API
Cliquez sur “Générer une clé API” et sélectionnez “Marketplace API key”
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
Accéder à Topsort Admin
Connectez-vous à votre tableau de bord d’administration Topsort
Naviguer vers les Paramètres API
Allez dans Paramètres → Accès API
Générer une Clé
Cliquez sur “Générer une Clé” pour créer votre clé Advanced API
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
