Skip to main content
Topsort uses two types of API keys for different purposes.

Quick Reference

Key TypeWherePurposeUser
Marketplace API KeyAdmin SettingsAll marketplace operationsBackend servers
Advanced API KeyVendor DashboardSingle vendor campaignsVendor tools

Which Key Do I Need?

EndpointKey Type
POST /v2/auctionsMarketplace
POST /v2/eventsMarketplace
POST /v2/productsMarketplace
GET /public/v1/reporting-service/*Marketplace
POST /public/v1/campaign-service/*Either (scoped to vendor if Advanced key)
GET /public/v1/billing-service/*Marketplace

Common Errors

401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}
Causes:
  • API key not included in Authorization header
  • Key is malformed or expired
  • Using Advanced key on Marketplace-only endpoint
Fix: Verify header format: Authorization: Bearer YOUR_API_KEY

403 Forbidden

{
  "error": "Forbidden", 
  "message": "Insufficient permissions"
}
Causes:
  • Using Advanced key for endpoint that requires Marketplace key
  • Advanced key trying to access different vendor’s data
Fix: Use Marketplace API key for cross-vendor operations

How to Get Your Keys

Marketplace API Key

1

Access Topsort Admin

Log in to your Topsort Admin dashboard
2

Navigate to API Settings

Go to SettingsAPI Integration
3

Create API Key

Click “Generate API key” and select “Marketplace API key”
4

Copy and Store

Copy the key immediately and store it securely (it’s only shown once)

Advanced API Key

1

Access Vendor Dashboard

Log in to your Topsort Admin Dashboard
2

Navigate to API Settings

Go to SettingsAPI Access
3

Generate Key

Click “Generate Key” to create your Advanced API key
4

Copy and Store

Copy the key and store it securely in your environment variables

Security Best Practices

  • Never commit keys to version control
  • Store keys in environment variables
  • Rotate keys regularly
  • Use different keys for different environments (dev, staging, production)
  • Restrict key access to only necessary team members

Key Permissions Scope

Marketplace API Key

  • Full access to all marketplace operations
  • Can create and manage campaigns for any vendor
  • Access to all reporting data
  • Required for auction and event endpoints

Advanced API Key

  • Limited to specific vendor’s data
  • Can only manage campaigns for the associated vendor
  • Cannot access other vendors’ information
  • Ideal for vendor-specific integrations
Last updated: