Knowledge BaseAPI ReferenceAPI Status

Authentication

Topsort's core API has 2 endpoints, /auctions and /events. Auctions are responsible for deciding the winner - often times a product or a listing or a creative that wins a unique promoted impression. Events are used for tracking the performance of the promoted listings and banners. You can monitor and check API Status here

❗️

Avoid round trip

Since we are intent on minimizing the impact of running auctions over your app, there is no redirect your app from trailing / endpoints to avoid an extra round trip before auction winners are returned, i.e. use /v1/auctions but not/v1/auctions/

Topsort Core API is authenticated via a bearer token. Requests must include an authorization header containing a marketplace API key. If such header is missing or invalid, the HTTP response code will be 401 Unauthorized.

POST /v1/auctions HTTP/2
Host: sandbox.app.topsort.com
...
Authorization: Bearer <YOUR-API-KEY>
...

Obtaining an API Key

By this point we will have provided you with credentials to log into Topsort's Auctions Manager. After logging in, open the API Integration page, then click on the Generate API key button.

492

Step 1: access the Topsort API Integration page by clicking on Settings, and then selecting API Integration.

1652

Step 2: generate an API key by pressing the Generate API key button.

764

Step 3: click on the Copy button at the right of the newly generated token to copy it into your clipboard.

👍

Pro Tips

  1. This token is not meant to be a public key. Please keep this token for server usage only, do not share it.
  2. If you have multiple marketplaces, you'll need to keep a set of API keys through different instances.