Documentation Integration API Reference Android SDK Web SDK Publishers Advertisers Log in Get Started
REST API reference

API shapes for custom reward surfaces.

Use the API when you want to render your own UI, inspect click context or connect server-side reward events. Examples use placeholders for site identity, users and signatures.

Offers APIClick lookupS2S HMAC
Authentication

Identify the site first.

Requests are scoped to a publisher site. Use the site key for public placement requests and the site secret for HMAC verification on server-side callbacks.

ValueWhere it is used
site_keyPublic identifier used by iFrame, Web SDK, Android SDK and Offers API.
site_secretPrivate value used to verify HMAC-signed postback payloads.
user_idPublisher-side user identifier passed through the reward flow.
Offers API

Fetch offers for a custom surface.

GET
/api/offers

Returns offer data for the supplied site and user context.

offers-request.txt
GET https://pro.adswedmedia.com/api/offers?site_key={site_key}
  &user_id={user_id}
  &format=offerwall
ParameterDescription
site_keyPublisher site key.
user_idPublisher user id.
formatPlacement format such as offerwall, banners, surveys or PTC.
Click lookup

Inspect a click before resolving an event.

GET
/api/click-lookup

Looks up click context for investigation and postback recovery workflows.

click-lookup.txt
GET https://pro.adswedmedia.com/api/click-lookup?site_key={site_key}
  &click_id={click_id}
S2S postbacks

Verify reward events with HMAC.

Credit, reject and chargeback events use the same callback shape. Verify the signature before applying the event.

postback-event.txt
event=credit|reject|chargeback
site_key={site_key}
user_id={user_id}
click_id={click_id}
reward={reward_amount}
signature={hmac_sha256}
Errors

Handle predictable failure states.

401

Unauthorized

Site identity or signature could not be verified.

404

Not found

The requested click, offer or resource could not be found.

422

Invalid input

Required parameters are missing or not accepted.

429

Rate limited

The client should slow down and retry later.