Time to read: 6 min

The article covers the following topics:

General Info

First of all, to get started with API, you need to find your API-key. To do it, just navigate to 'Users' Tab - > 'Users management' -> 'User edit page':

Only the General manager has permission to get the 'User edit page'.

Next thing you need is API URL, you can find it in Settings tab -> Settings -> Tracking domains -> Default URL's tab.

Find out more about where you can find your/Affiliate's API-key and API URL here.

API Request Structure:

GET/POST + api domain + path + ? + api-key=189471975956279174174.

It should be noted that header content-type - application/x-www-form-urlencoded is used on an ongoing basis, and content-type - multipart/form-data is used for uploading files (logo, creative files).

What do I need to check?

If you receive a request from your Affiliate that the offers you've approved for him/her are not visible via API, follow the steps below:

  • Check the pagination at Step 1.

  • Check the Affiliate status. Make sure that your Affiliate is in 'Active' status if not, then move to Step 2.

  • Check the Offer status. Make sure that the Offer is in 'Active' status if not, then move to Step 3.

  • Check the Offer privacy level. If the offer is private or pre-moderation, make sure that Affiliate is enabled for this offer if not, then move to Step 4.

  • Check the Advertiser's settings. Make sure that Advertiser is not disabled for an Affiliate if not, then move to Step 5.

Step 1: Pagination

The partner may not be able to see all the offers because of the pagination. GET methods provide pagination with 100 entries per page. If you want to get data for a specific page, add the &page parameter to the request.

Example:

https://api-rocketcompany.affise.com/3.0/offers?api-key=a227fe0ec61dd5467368266c12345678&page=3

Step 2: Affiliate status

First of all, make sure that your Affiliate is in "Active" status. To check Affiliate status, you need to navigate to the 'Affiliate managing (admin methods)' section in the API Doc and use the 'Get Affiliate' method (follow the link):

chrome-capture__68_.gif

❗ Note that if Affiliate has "Banned", "On moderation", or "Not active" status, her/she will not see offers.

To change Affiliate status, you need to navigate to the 'Affiliate managing (admin methods)' section in the API Doc and use the 'Edit Affiliate' method (follow the link) under 'status' parameter:

chrome-capture__69_.gif

❗ When you want to change the data, it is very important to re-specify all the old values; otherwise, all the existing values automatically will have a null value (deleted), and you will lose the important information.

You also can update the status of many affiliates via API: here is a method.

Step 3: Offer Status

Make sure that the offer is in "Active" status, not "Paused" or "Disabled".
"Paused" and "Disabled" offers are not visible for the affiliates.

To check Offer status, you need to navigate to the 'Offers' section in the API Doc and use the 'Offer by id' method (follow the link):

chrome-capture__70_.gif

To change Offer status, you need to navigate to the 'Offer managing (admin methods)' section in the API Doc and use the 'Update offer`s status' method (follow the link) under 'status' parameter:

chrome-capture__71_.gif

Step 4: Offer Privacy level

Offer can not be visible to Affiliate because of its privacy level that affects Affiliates' access to the Offer's Tracking URL.

There are three levels:

  • public – the offer is available for all affiliates without any request by default. You do not need to enable affiliates for the public offer;

  • pre-moderation – requires the network manager's confirmation for an affiliate to have access to the offer;

  • private – the offer is not visible from the affiliate's side, except affiliates connected by the manager from the admin side.

Private offers are not visible for the affiliates.

If the offer is private or pre-moderation, make sure that Affiliate is enabled for this offer. To enable Affiliate for Offer (-s), you need to navigate to the 'Offer managing (admin methods)' section in the API Doc and use the 'Enable Affiliate' method (follow the link):

Where,

  • offer_id[] - required parameter. You may enable Affiliate for one specific Offer, or several Offers. cURL example:

curl --location --request POST 'https://api-rocketcompany.affise.com/3.0/offer/enable-affiliate' \
--header 'api-key: bf09c801ff9b95b14ac8e17d6e111111' \
--header 'Content-Type: multipart/form-data' \
--form 'offer_id[]=132118' \
--form 'offer_id[1]=132115' \
--form 'pid=15'
  • pid - required parameter. Enter here Affiliate ID.

  • notice - optional parameter. You may send a notification for Affiliate.

Step 5: Advertiser's settings

First of all, check the Advertiser's settings and make sure that your Affiliate is not in the blacklist of Advertiser. If so, your next move is to enable Affiliate for Advertiser. To do this, you need to navigate to the 'Advertiser managing' section in the API Doc and use the 'Advertisers enable affiliate' method (follow the link):

Where,

  • advertiers_id - required parameter. You may enable Affiliate for one specific Advertiser, or several Advertisers. cURL example:

curl --location --request POST 'https://api-rocketcompany.affise.com/3.0/admin/advertiser/enable-affiliate' \
--header 'api-key: bf09c801ff9b95b14ac8e17d6e111111' \
--header 'Content-Type: multipart/form-data' \
--form 'advertisers_id[]=5eda85c05031a86a89111111' \
--form 'advertisers_id[1]=5eda851f1d37036cff111111' \
--form 'pid=15'
  • pid - required parameter. Enter here Affiliate ID.

You may also find the following articles helpful:


If you have more questions on the 'Why Affiliate does not see the Offers via API', feel free to contact the Affise Support Team via [email protected] or your Dedicated Account Manager.

Did this answer your question?