Documentation

API feed for publishers

Your live offers in JSON, to load them automatically.

Overview

To use the API feed, your account must be enabled: ask your account manager or write to ops@mapendo.me. You will receive a secret key to add to every request.

The feed returns only the offers approved and live for your account, not every offer of the Mapendo network. When an offer stops it disappears from the feed. To keep offers and statuses up to date, refresh the feed every 30 minutes.

Request

Requests use HTTP GET. The base address is:

GEThttp://api.apperol.com/feed/

You can get all your live offers at once, or filter them:

ParameterDescriptionExample
secret_key Your secret key, given by Mapendo when the API feed is enabled for your account. YOUR_SECRET_KEY Required
platform Only the offers of one platform: 1 Android, 0 iOS. 1 Optional
country Only the offers of a country, as ISO 3166-1 alpha-2 code.* US Optional
ip IP address of the user: we find the country and return the offers available there.* 192.168.0.1 Optional
creatives 1 to get the creatives in the response (when available), 0 (default) without. 1 Optional

* With both ip and country, ip wins: we filter on its country only.

Example

http://api.apperol.com/feed/?secret_key=YOUR_SECRET_KEY&platform=1&country=IT&creatives=1

Response

The feed always answers with HTTP 200, also when there are no offers or the request is wrong. The body is JSON: the list of offers, or the reason of the error.

campaigns
The list of your campaigns: the whole response is inside this element.
id
The campaign ID, yours on Mapendo.
offer_id
The offer ID: it identifies the offer in the whole network.
payout
The CPI paid to you for one install, in USD.
preview_link
The App Store or Google Play page of the app.
platform
The platform of the campaign: 0 iOS, 1 Android.
click_url
The base tracking link to send traffic to the campaign. To receive our install postbacks add the guid parameter (see the S2S integration); to optimize, pass us your sub ids in placement.
impression_url
The base impression link. It needs impressionid and placement (see the S2S integration). Device ids, app names, bundles and creatives passed in the click link should be passed here as well.
description
A short description of the offer, that can also be a call to action in a text ad.
notes
Details about the promotion: restrictions, traffic allowed, forbidden activities… (when present).
package
The Google Play package id or the App Store id of the app.
country
The country or countries of the offer; INTL means worldwide.
title
The name of the app, that can also be used in a text ad.
icon_url
The square icon of the app.
creatives_zip
A zip file with all the creatives, to download.
blacklist_sub_ids
Your sub publisher IDs (the placement values) that should not be used for this campaign.
daily_cap
The daily installs assigned to you.
status
0 live, 1 paused (for example when the daily cap is reached). A campaign no longer available to you disappears from the feed.
deviceid
1: send the device id in the tracking link (idfa for iOS, gaid for Android), traffic without it will not convert; 0: all traffic is accepted.
creatives
The creatives of the offer (an empty list when there are none), each with id, url, size and name.

Example (offers)

{
  "campaigns": [
    {
      "id": 84,
      "offer_id": 1236,
      "payout": 1.40,
      "platform": 1,
      "preview_link": "https://play.google.com/store/apps/details?id=com.dianxinos.optimizer.duplay",
      "click_url": "https://trk.apperol.com/track/?campaign=84",
      "impression_url": "https://trk.apperol.com/impression/?campaign=84",
      "description": "DU Speed Booster is an Android optimizer & cleaner master",
      "notes": "Non-incentivized traffic only.",
      "package": "com.dianxinos.optimizer.duplay",
      "creatives_zip": "https://example.com/creatives/du_speed_booster.zip",
      "country": "INTL",
      "title": "Du Speed Booster",
      "icon_url": "https://example.com/icons/du_speed_booster.png",
      "blacklist_sub_ids": [],
      "daily_cap": "150",
      "status": 0,
      "deviceid": 0,
      "creatives": []
    },
    {
      "id": 85,
      "offer_id": 987,
      "payout": 0.90,
      "platform": 1,
      "preview_link": "https://play.google.com/store/apps/details?id=it.doveconviene.android",
      "click_url": "https://trk.apperol.com/track/?campaign=85",
      "impression_url": "https://trk.apperol.com/impression/?campaign=85",
      "description": "Risparmia oltre il 50% su Shopping e spesa!",
      "notes": "Non-incentivized traffic only. GAID required.",
      "package": "it.doveconviene.android",
      "creatives_zip": "https://example.com/creatives/doveconviene.zip",
      "country": "IT",
      "title": "Doveconviene",
      "icon_url": "https://example.com/icons/doveconviene.png",
      "blacklist_sub_ids": ["23523564574", "92357237751"],
      "daily_cap": "250",
      "status": 1,
      "deviceid": 1,
      "creatives": [
        {"id": "1357", "url": "https://example.com/creatives/IT_320x50_risparmio.png", "size": "320x50", "name": "IT_320x50_risparmio.png"},
        {"id": "1358", "url": "https://example.com/creatives/IT_320x50_device.png", "size": "320x50", "name": "IT_320x50_device.png"}
      ]
    }
  ]
}

Example (no offers)

{
  "campaigns": []
}

Example (error)

{
  "error": "secret_key parameter is mandatory!"
}