OpenRTB Quick Start
Four steps take a new supply partner from credentials to live traffic.
1. Request an endpoint key
Endpoint keys are issued by the adon3 integration office, not through a
dashboard. Write to [email protected] with:
- Your company name and a technical contact
- Your seller domain, and the
sellers.jsonURL where it is published - The formats you sell: banner, video, audio or native
- The OpenRTB version you send,
2.6or2.5 - The countries and daily volume you expect
You will be sent back:
- An endpoint key for
rtb.adon3-ads.com - Your SSP id and a reporting auth key for
reports.rtb.adon3.com - Sandbox credentials
- A shared Microsoft Teams channel with your integration engineer
2. Publish and verify your supply chain
Before the first auction, your sellers.json must be reachable and your
source.schain must resolve against it.
# Your sellers.json must be reachable and valid JSON
curl -sS https://example-ssp.com/sellers.json | head -40
Every node's asi and sid must appear in the sellers.json at that asi
domain. Requests with an unresolvable chain are rejected with SCHAIN_INVALID
before reaching any bidder, so no amount of request-side work will fix them.
3. Post your first request
curl -sS -X POST 'https://rtb.adon3-ads.com/v1/auction/ek_31c9b7e2a04d' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'x-openrtb-version: 2.6' \
--data-binary @sample-banner.json
A bid comes back as 200 with a BidResponse. No bid is 204 with an empty
body, which is a normal outcome and not an error.
Check the four things we require before you debug anything else: device.ua,
one of device.ip or device.ipv6, one of site.domain or app.bundle, and a
BidRequest.id. Most first-day 400s are one of those four.
4. Render, notify and reconcile
When you get a bid:
- Substitute the macros in
adm,nurlandburl. See Substitution Macros. - Render
admin the slot the impression came from. - Fire
nurlon the win, andburlwhen the impression is counted. - Bill against the substituted
${AUCTION_PRICE}, never against the rawbid.price.
Then pull your figures from reporting daily while you ramp,
and compare impressions and revenue against your own counts. Reporting
reconciles to the impression and is authoritative for billing. Raise discrepancy
claims within 30 days, as set out in the charter.
What to read next
Bid Request documents every object you send us. Bid Response documents what we return. Testing covers the sandbox and the go-live checklist.