Introduction
Welcome to AdMantum's documentation page, an account is required in order to use any of our tools.
Getting Started
An Account is required to continue with App setup and configuration. Once you have created an account you will have full access to our platform.
You can create an account by following these steps :
- Navigate to AdMantum Registration Page
- Fill up the Registration form and click on Sign Up.
- After that you can login to your members area.
Creating an App
An application is required to use any of our tools. Once you have created an app you will have an API KEY and a SECRET KEY (But before it you will have to wait until your site or app get approved), after that you will need to integrate our offerwall to your app.
You can create an app by following these steps :
- Login to your AdMantum Account
- In Menu, click on
Apps -> Add New App. - Complete all the form fields with the App details and click on 'Create App'.
AppId & Secret Key
An AppId is required to our offerwall to your users or to retrevive our offers.
You can get both the AppId & Secret Key by following these steps :
- Login to your AdMantum Account
- In Menu, click on
Apps -> Manage Apps. - Copy the AppId & Secret Key from the list of your Apps.
OfferWall Integration
Integrating our OfferWall can be done in any one of the following menthods.
Important!
All of the below methods expect you to pass a valid AppId to show appropriate offerwall and a userId from your App or Website.
Direct Link
Link directly to your offerwall with this URL, app developers may want to use this URL as a direct link, perfect for links on website.
https://www.admantum.com/offers?appid=[APP_ID_HERE]&uid=[USER_ID_HERE]
Please replace [APP_ID_HERE] with your AppId and [USER_ID_HERE] with the userId from your App or Website.
Iframe / Embed Tag
This tag is ideal for users with websites in which they want to embed the offerwall directly on it, perfect for whitelabeling, games / rewards / gpt websites.
Script Tag
This tag can be placed on any website, we will automatically detect desktop vs mobile users and show your offerwall accordingly.
Note!
To pass a subID to your offerwall, add &subid=[Sub_ID_Here] to the end of your url. Review our Postback Documentation on how to setup crediting.
Postback Notifications
Whenever a user makes a conversion, we will send you a URL request, called a 'Server to Server Postback' with some information. Using this information, you can reward the user who performed the action accordingly.
The postback will be sent to the postback URL you have defined in while creating the App and can be changed from the Edit App section. And currently we are sending all the data in POST method only.
A valid postback url should be as following ..
https://www.Your-Site.com/pb/?offer_id={of_id}&user_id={uid}&amount={virtual_currency}&status={status}
Our Mandatory Parameters are uid and virtual_currency. You can also pass/receive additional subids, using the following subid parameters : subid, subid2, subid3. Please check our parameters list for complete info.
Postback Parameters List
{uid} and {virtual_currency} are our mandatory parameters. All Parameters are Case sensitive, any other macros will be stripped from the URL.
Incase you don't need the parameter {virtual_currency} we expect {payout} parameter to be present.
| {uid} | Unique id of the user, passed by the publisher. |
| {transaction_id} | Unique id of the transaction from AdMantum. Use this to prevent duplicate conversions. A new transaction Id will be generated for reversal. |
| {status} | Determines whether to add or subtract the amount. status = 1 for completion and 0 for reversal. |
| {of_id} | Id of the completed offer. |
| {of_name} | Name of the completed offer. |
| {event_id} | Id of the completed offer event. Empty for non Multi-reward offers. |
| {event_name} | Name of the completed offer event as displayed to the user. [Example : Reach Level 5] Empty for non Multi-reward offers. |
| {virtual_currency} | The amount of your virtual currency to be credited to your user. [Example : 1500] |
| {currency} | The name of your virtual currency. [Example : Points] |
| {payout} | The publisher's revenue in USD for the conversion. [Example : 2.50] |
| {ip} | The user's IP address who completed the action. |
| {hash} | Hash string to verify that the postback is coming from our servers and not tampered.
Hash string is a MD5 of uid of_id virtual_currency Secret Key |
| {subid} | Custom parameter value that will be passed in case you have sent us the subid data (optional). |
| {subid2} | Custom parameter value that will be passed in case you have sent us the subid2 data (optional). |
| {subid3} | Custom parameter value that will be passed in case you have sent us the subid3 data (optional). |
Contact us for additional {subid4} and {subid5} to be enabled for your Account.
Expected Response
Our servers expect a response OK from your postback URL. If this response is not received from your URL, we will attempt to resend the postback up to 5 times. There is a 5 minute delay between each attempt.
Postback Example Script
For complete custom script setups, AdMantum offers a basic postback example script that should give you, or your developer, an idea how a custom AdMantum postback script should function. Please check our parameters list for complete info.
Offers API
Our offers API allow you to fetch offers and display them natively on your website or app.
API URL
https://admantum.com/api/v3/offers/?appid=[APP_ID_HERE]&uid=[USER_ID_HERE]&ip=[USER_IP]&device=[USER_DEVICE]
Please replace [APP_ID_HERE] with your AppId and [USER_ID_HERE] with the userId from your App or Website.
API Parameters
| Parameter | Description | Type | Example |
| appid | Your App ID. Can be found on the Manage Apps page. This id should not be empty or 0. | Required | ?appid=1234 |
| uid | The id of the user from your App or Website. | Required | &uid=1234 |
| ip | Filters the list of offers available for the country that is obtained with the IP.
Alternatively use country parameter. |
Optional | &ip=198.68.11.250 |
| country | Filters the list of offers available for that country. Must be an ISO2 standard. | Optional | &country=US |
| device | Filters the list of offers available to that device. Only one device at a time must be passed.
Device Options : android desktop iphone ipad |
Optional | &device=android |
| subid | Custom parameter to pass any additional data that you may need. | Optional | &subid=CUSTOM_DATA |
| subid2 | Custom parameter to pass any additional data that you may need. | Optional | &subid2=CUSTOM_DATA |
| subid3 | Custom parameter to pass any additional data that you may need. | Optional | &subid3=CUSTOM_DATA |
Note that country abbreviations use the ISO standard, e.g. GB instead of UK.
Contact us for any help with the integration.
API Response
{
"success": true,
"app_currency": "Points",
"offers_count": 1926,
"offers": [
{
"offer_id": 1163996,
"offer_type": "CPI",
"offer_trending": false,
"offer_difficulty": "easy",
"offer_title": "Photoleap: AI Art Photo Editor",
"offer_description": "Transform your images with Photoleap, the most powerful photo editing app on the market!",
"offer_requirements": "Install and Run the App to get the reward",
"offer_instructions": [
"Install and Run the App",
"Confirms Instantly",
"New Users Only"
],
"offer_image": "https://admantum.com/offers/img/src/mtebhdk5nq.png",
"offer_preview": "https://apps.apple.com/us/app/photoleap-ai-art-photo-editor/id1191337894",
"offer_link": "https://www.admantum.com/click?offer=1163996&app=1234&user=1234",
"offer_epc": 0,
"offer_payout": 0.35,
"offer_virtual_currency": 750,
"offer_categories": [
"Cpi",
"Free"
],
"offer_devices": [
"iphone",
"ipad"
],
"offer_countries": [
"IN",
"US",
"MA"
],
"offer_events": []
},
{
"offer_id": 1163931,
"offer_type": "CPE",
"offer_trending": true,
"offer_difficulty": "hard",
"offer_title": "Candy Crush",
"offer_description": "Match, pop, and blast candies in this tasty puzzle adventure to progress to the next level and get a sugar blast!",
"offer_requirements": "Install the Game and Reach the listed levels within 28 days.",
"offer_instructions": [
"Install the Mobile Game",
"Reach the listed levels within 28 days",
"Confirms in 30 days",
"New Users Only"
],
"offer_image": "https://admantum.com/offers/img/src/mte1odg4mq.png",
"offer_preview": "https://apps.apple.com/ph/app/candy-crush-saga/id553834731",
"offer_link": "https://www.admantum.com/click?offer=1163931&app=1234&user=1234",
"offer_epc": 0.5,
"offer_payout": 20.23,
"offer_virtual_currency": 101150,
"offer_categories": [
"Game",
"Free"
],
"offer_devices": [
"ipad",
"iphone"
],
"offer_countries": [
"US",
"GB"
],
"offer_events": [
{
"event_name": "Install App",
"event_payout": 0,
"event_virtual_currency": 0
},
{
"event_name": "Reach Level 25",
"event_payout": 0.07,
"event_virtual_currency": 350
},
{
"event_name": "Reach Level 100",
"event_payout": 0.72,
"event_virtual_currency": 3600
},
{
"event_name": "Reach Level 300",
"event_payout": 1.44,
"event_virtual_currency": 7200
},
{
"event_name": "Reach Level 650",
"event_payout": 3.6,
"event_virtual_currency": 18000
},
{
"event_name": "Reach Level 990",
"event_payout": 12.96,
"event_virtual_currency": 64800
},
{
"event_name": "Make a Purchase",
"event_payout": 1.44,
"event_virtual_currency": 7200
}
]
},
{
"offer_id": 1164045,
"offer_type": "CPE",
"offer_trending": false,
"offer_difficulty": "medium",
"offer_title": "Super Car Escape",
"offer_description": "Tap on cars and escape from the traffic jam in Car Escape!",
"offer_requirements": "Install the Game and Reach level 101 to get the reward",
"offer_instructions": [
"Install the Mobile Game",
"Reach level 101",
"New Users Only"
],
"offer_image": "https://admantum.com/offers/img/src/mte1odk5nq.png",
"offer_preview": "https://play.google.com/store/apps/details?id=com.Supermonic.carescapes",
"offer_link": "https://www.admantum.com/click?offer=1164045&app=1234&user=1234",
"offer_epc": 0.5,
"offer_payout": 1.19,
"offer_virtual_currency": 1950,
"offer_categories": [
"Game",
"Free"
],
"offer_devices": [
"android"
],
"offer_countries": [
"US",
"SA",
"GB"
],
"offer_events": []
},
...
]
}