How Offer Sync API v2 Works?

General Purpose of Using API feature is to import/sync offers quickly from advertisers platform, respectively.To access this feature, Go to;

Tools > Offers Sync.

Step-1: Select Network / Partner Platform (Here, click on setup button of partner platform or partner network )

Step-2: Specify advertiser name.

Step-3: API End Point (it will be API URL for preview only, nothing can be changed in this.)

Credentials: (These will be API details given by advertiser which will include API domain, Key as main credentials. usually, these always change as per partner platform)

Options: Options row includes various configurations settings that user wants to make in imported offers, such as affiliate payout%, API schedule, Automatically remove/add tokens in Offer URLs, assigning offers to advertisers and so on. using these options will help to do complex things with ease.

Fields

Description

AFFILIATE PAYOUT %

This helps in specifying the % of payout you want to share with your publishers/ affiliate, For E.g. you want to give your affiliates 70% of the amount received for that offer synced from API. then, you just need to enter 70, here.

REMOVE TOKENS: CLICK URL

Using this option will help the user to remove unnecessary tokens in Offer URL, (Which are already being sent by the advertiser). for removing multiple tokens, the user has to use || while entering multiple values of tokens. for E.g you want to remove cid={your-click_id]&aid={your_affiliate's_id} in advertiser URL. Now, user just need to enter data like this => cid={your-click_id] || &aid={your_affiliate's_id}

ADDITIONAL TOKENS: CLICK URL

The user can Add Multiple tokens in offers URLs that got synced in API using this option tool, he only had to enter tokens that he wants to add in CLICK URL.

SCHEDULE

This is the time Schedule defines that after how much time API should be updated automatically. (by default it is configured to every 6 Hours starting from latest manual sync.

ADVERTISER PROFILE

This would be the profile of that advertiser you created under which all of the synced offers will get saved/allots to that advertiser's profile.

OFFER VISIBILITY

The user can select by default visibility status for synced offers for affiliates. from Public, Public + Approval Required or Private.

GLOBAL FALLBACK

User can set if the Global Fallback Configured by him, would also be applicable to those synced offers or not

EXPIRE OFFERS

User can configure what settings should be applied to the offers which are not got synced in 2 scheduled/manual sync of the API, Suppose at the first time 50 offers got synced, but on the 2nd time out of 50 only 40 got synced + 10 new offers also got synced, in this case, those 10 offers which are not synced, system should treat as expired offers or not?

TIME SCHEDULE (UTC)

User can manually set time of API sync. For E.g He wants to sync API at 5.00(UTC), after then 18.15(UTC), so, here he can configure settings like 5.00,18.10 OR 18.20.

Fields Sync These are the fields which can be configured by the user to sync either always or one time or never.

Once Configuration is done by users as guided above

Click on Submit. to save API details

then, Click on Debug Run. To start Synchronizing.

QUICK LINKS TO API INTEGRATED PARTNER GUIDE