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 :

  1. Navigate to AdMantum Registration Page
  2. Fill up the Registration form and click on Sign Up.
  3. 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 :

  1. Login to your AdMantum Account
  2. In Menu, click on Apps -> Add New App.
  3. 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 :

  1. Login to your AdMantum Account
  2. In Menu, click on Apps -> Manage Apps.
  3. 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.

uid The id of your user. This id should not be empty or 0.
transaction_id Unique id of the transaction made by your user on AdMantum. 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.
virtual_currency The amount of your virtual currency to be credited to your user.
currency The name of your virtual currency.
payout The publisher's revenue for this conversion.
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 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.


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/v2/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.
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": 3,
    "offers": [
        {
            "offer_id": 948091,
            "offer_title": "Street Guy",
            "offer_description": "Reach Level 5 (New Users Only) ",
            "offer_image": "https://www.admantum.com/offers/img\/948091.png",
            "offer_link": "https://www.admantum.com/click/off_c?appid=1234&uid=1234&legacy=eyJhIjoiZSIMX0",
            "offer_payout": 3.50,
            "offer_virtual_currency": 350,
            "offer_countries": "US",
            "offer_device": "android"
        },
        {
            "offer_id": 946052,
            "offer_title": "BioX Trader",
            "offer_description": "Make a Deposit of at Least $1+",
            "offer_image": "https://www.admantum.com/offers/img/946052.png",
            "offer_link": "https://www.admantum.com/click/off_c?appid=1234&uid=1234&legacy=sIjoiMTE5Njki",
            "offer_payout": 3.25,
            "offer_virtual_currency": 325,
            "offer_countries": "US",
            "offer_device": "iphone"
        },
        {
            "offer_id": 970623,
            "offer_title": "Parking Line - Car Park Puzzle",
            "offer_description": "First Time Users. Complete Level 10. You must click if tracking permission is requested within the app. Confirms in 2 days 5 hours",
            "offer_image": "https:\/\/www.admantum.com\/offers\/img\/970623.png",
            "offer_link": "https:\/\/www.admantum.com\/click\/off_c?appid=1234&uid=1234&legacy=sInAiOiIyMT",
            "offer_payout": 2.80,
            "offer_virtual_currency": 280,
            "offer_countries": "US",
            "offer_device": "ipad"
        }
    ]
}