Using the Configuration API
The configuration API enables you to create, store, and eventually update an existing bidder configuration. The sections below describe the endpoints you can call to work with these bidder configurations.
Create Config Endpoint
You can call the Create Config endpoint by using the URL below.
https://e.relay.bid/m/v1/create-config?a=ACCOUNT_ID
The purpose of this endpoint is to allow you to create and store a bidders configuration. You will be returned a supply_id that can be used in place of the full bidders configuration. This also allows you the ability to specify less on the Exchange API request, as well as change the configuration used on these requests, independent of the request itself.
The create-config
endpoint accepts a JSON body of the following form:
```
{
"name": "My Saved Configuration",
"bidders": {
"index": {"siteId": 123456},
"appnexus": {"placementId": "abcdef"}
}
}
```
The response includes a supply id, and a UUID. This can be used with the supply_id type request detailed above.
Configuration APIs
Kevel Relay’s configuration APIs are separated into distinct endpoints you can use, depending on what you would like to accomplish. You can use the following Configuration APIs shown in the table below.
If you would prefer not to use the Configuration APIs, you may also use the user interface to store configurations and link them on your exchange API requests.
API | Description | URL |
---|---|---|
Demand Sources | Create and Manage connections to SSPs, DSPs, and ad servers. | https://e.relay.bid/m/v1/demand_source/ |
Demand | Create and manage individual units of demand configuration. | https://e.relay.bid/m/v1/demand/ |
Supply | Create and manage groups of inventory with shared settings. | https://e.relay.bid/m/v1/supply/ |
Channels | Create and manage individual sources of inventory. | https://e.relay.bid/m/v1/channel/ |
Sites | Create and manage sites. | https://e.relay.bid/m/v1/site/ |
Apps | Create and manage apps. | https://e.relay.bid/m/v1/app/ |
DOOH | Create and manage DOOH devices. | https://e.relay.bid/m/v1/dooh/ |
Placements | Create and manage multiple placements on channels or across inventory. | https://e.relay.bid/m/v1/placement/ |
Deals | Create and manage Private Marketplaces (PMP) deals. | https://e.relay.bid/m/v1/deal/ |
Display Placements | Configure specific settings for display ads on a placement. | https://e.relay.bid/m/v1/display_placement/ |
Audio Placements | Configure specific settings for audio ads on a placement. | https://e.relay.bid/m/v1/audio_placement/ |
Video Placements | Configure specific settings for video ads on a placement. | https://e.relay.bid/m/v1/video_placement/ |
Update Config Endpoint
Note
The documentation for this API endpoint is currently in process and being developed. We will release this updated content shortly.