Authentication
PubAdHub APIs use publisher credentials (AccessKey, PublisherKey, pubi, and the OpenRTB Publisher Identity) and a separate platform access_key for S2S postbacks. Bearer tokens are not used.
manage_accounts Where to find your keys
Your Access Key and Publisher Key are available in the PubAdHub Console.
- Click your account profile icon in the top-right corner.
- Select Settings.
- On the Publisher Settings page, you will find your Access Key and Publisher Key.
Console URL: https://console.pubadhub.com
key Access Key
Used by Brand List, Brand List by Traffic Type, Revenue Share Report, and Click-Level Conversion Report. Send the key in the AccessKey HTTP request header. Copy the value from Console → Settings → Publisher Settings.
AccessKey: {AccessKey}
Applies to:
Publisher Key
Required for Amazon Seller Product Search and Affiliate Product Search. Send it as the PublisherKey HTTP header. Copy the value from Console → Settings → Publisher Settings, or contact your Account Manager. Do not send an AccessKey header on Affiliate Product Search.
PublisherKey: {PublisherKey}
Applies to:
badge Publisher ID
Your Account Manager provides the Publisher Id for the RTB Serving Engine, sent as the query parameter pubi. OpenRTB 2.5 sends your Publisher Identity as the {PublisherKey} path segment. There is no Authorization header on either endpoint. The OpenRTB path value is not the PublisherKey header used by product search.
pubi={PublisherID}
POST http://rtb.pubadhub.com/openrtb/{PublisherKey}
Applies to GET http://rtb.pubadhub.com/serving-engine and POST http://rtb.pubadhub.com/openrtb/{PublisherKey}.
hub Platform Access Key Platform
Required for the S2S Postback API. Place the key in the URL path — do not send an AccessKey header. Contact your Account Manager for your platform access_key and complete postback URL. Each platform receives a unique key; do not reuse keys across platforms.
GET /api/postback/{access_key}?txnid=...&cid=...&edate=...&payout=...
Applies to GET or POST https://statsapi.pubadhub.com/api/postback/{access_key}.
Documented practices
check_circle Recommended
- doneGet your Access Key and Publisher Key from the PubAdHub Console.
- doneBrand List: set appropriate timeout values, enable redirect handling, use a stable HTTP version, and implement proper error and timeout handling. Handle commission_rate and optional flat_fee; map offer_id, brand_name, merchant_category, and verification_status; check restricated_traffic before cashback promotion. On tracking URLs, replace clickid (required) and optional subi, psorc, pcat, subid1–subid5, and dl on deeplink URLs. Use offer_id to match Brand List with Revenue Share.
- doneBrand List by Traffic Type: send
traffic_typewithAccessKey. Treat HTTP 200 withNo active brands found.as an empty filter, separate from HTTP 400 and HTTP 401. - doneAmazon Seller Product Search: always use
redirect_urlfor outbound product clicks so tracking is preserved. - doneAffiliate Product Search: send
PublisherKeyon every request and useredirect_urlfor Shop / Buy clicks. Empty results still return HTTP 200 withmessage: No result found. - doneS2S Postback (Platform): put access_key in the URL path; inspect message / error_code even when HTTP status is 200; set appropriate timeout values and implement proper error and timeout handling.
- donePublisher S2S: share your full S2S URL with PubAdHub; accept HTTP GET; return HTTP 2xx after storing the details. No AccessKey header is used — PubAdHub calls you.
- doneOpenRTB 2.5: put your Publisher Identity in the URL path and keep it on the server. Send
device.ip,device.ipv6, or both. Readpriceas USD earnings per click. Treat HTTP 204 as no ad.
cancel Not used
- closeBearer
Authorizationheaders are not used. - closeDo not invent custom header names. Use
AccessKeyandPublisherKeyexactly as shown. - closeDo not send an AccessKey header on the Platform S2S Postback endpoint.
- closeDo not treat Publisher S2S as a PubAdHub API you call. You host the URL; PubAdHub sends the GET.