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 your 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 ..
http://www.Your-Site.com/pb/?offer_id={of_id}&user_id={uid}&amount={virtual_currency}¤cy={currency}&user_ip={ip}
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.
uid | The id of your user. This id should not be empty or 0. |
of_id | ID of the completed offer. |
of_name | Name of the completed offer. |
currency | The name of your virtual currency. |
virtual_currency | The amount of your virtual currency to be credited to your user. |
payout | The publisher's revenue for this conversion. |
ip | The user's IP address who completed the action. |
subid | Custom parameter value that will be passed in case you have sent us some subid data (optional). |
subid2 | Custom parameter value that will be passed in case you have sent us some subid data (optional). |
subid3 | Custom parameter value that will be passed in case you have sent us some subid data (optional). |
Contact us for additional subid4
and subid5
to be enabled for your Account.
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.