1. Home
  2. VaultPro API
  3. API Documentation

API Documentation

Welcome to the VaultPro, the affordable affiliate tracking tool developer documentation.

You’ll find comprehensive guides and documentation to help you start working with VaultPro as quickly as possible, as well as support if you get stuck. Let’s jump right in by clicking any of the options below:

  1. Authentication
  2. Documentation
  3. Campaigns/Offers list API

Authentication

Sign up with VaultPro, marketing campaign tracking software and generate Client API key to access and use VaultPro web services. Authenticated users only can access the web services in VaultPro.

Generate Client API key

To generate an API key, simply follow the below steps.

  • You can find your secret API key under the Profile -> API Key section. If API key is not generated, then generate the new API key using “Generate API key” option.
  • After generating the API key you will get below details,
    • API endpoint
    • X-API-KEY
    • X-CLIENT-API-KEY

  • In your API request you need to send this standard API keys “X-API-KEY” and client API key as “X-CLIENT-API-KEY”.
"X-API-KEY":"YOUR API KEY"
"X-CLIENT-API-KEY":"YOUR CLIENT API KEY"

API

To get started, a couple of things need to remember.

  • VaultPro API’s are Restful API’s and support only the HTTPS protocol.
  • All the APIs require standard API key and client API key for authentication.
  • VaultPro API’s supports only JSON. POST request params requires only JSON body.

API endpoint

https://{base_url}/{version}/ 

Microservices

Administrator

admin/

Advertiser

adv/

Affiliate

aff/

Headers

ATTRIBUTETYPEDESCRIPTION
Content-TypeStringApplication/x-www-form-urlencoded
X-API-KEYStringStandard API KEY
X- CLIENT-API-KEYStringClient Secret API KEY

HTTP Methods

HTTP METHODDESSCRIPTION
GETMake a GET request to retrieve data. GET requests will never cause an update or change to your data because they’re safe.
POSTUse a POST request to create new resources. For example, make a POST request to a collection endpoint (like \/lists) where the body of your request JSON is a new list.
PUTUse a PUT request to update the resource with the new resources provided with the request body. The request body should be in JSON.
DELETEMake a DELETE request to remove a resource.

Errors

We expose API errors in two ways: Standard HTTP response codes and Human-readable messages in JSON format. For example, the following code snippet shows an HTTP 405 error in the response headers: And this snippet shows the human-readable error as a JSON object, we recommend reviewing the Application Error Codes for more context to help you troubleshoot.

HTTP Status Codes

STATUS CODEDESCRIPTION
404Resource not found
500Service error, please contact support
501Request URL not found
503Service unavailable

Application Status Codes

STATUS CODEDESCRIPTION
0Response success
3User is blocked by AdvertiserU
4User status is in-active
6In valid user or user not found
9Missing required parameters
10Invalid parameter name or Bad request
11Access denied
999Server error

Campaign / Offers List API

This endpoint allows you to get all offers.

Requested URL

https://{baseurl}/{version}/{microservices_type}/api/getalloffer

Headers

X-CLIENT-API-KEY
REQUIRED
StringClient API key
X-API-KEY
REQUIRED
StringStandard API key
Content-Type*
REQUIRED
Stringapplication/x-www-form-urlencoded

Body Parameters

Limit
OPTIONAL
StringLimit
Timestamp
REQUIRED
StringtimeStamp
Offset
OPTIONAL
StringOff-Set
Sort
OPTIONAL
StringASC / DESC

Response

Success: OK

Data successfully retrieved.


{
"data": [
{
"offer_id": 1,
"offer_name": "Test_Offer - CPR",
"offer_type": "CPR",
"offer_category": "Others",
"offer_logo": "https://sample.com/5b752b9297535_1534405522.jpg",
"offer_description": "<h1>Test Offer</h1>",
"internal_tracking_link": "https://sample.com/offer_id=1&aff_id=1",
"additional_file_information": "Test Offer information",
"conversion_tracking": "Server Postback W/Transaction ID",
"offer_start_datetime": "2017-12-10 06:44:01",
"offer_end_datetime": "2017-12-10 06:44:01",
"reference_d": "12",
"offer_black_out_date": [
{
"black_out_start_date": "2017-08-16 07:45:00",
"black_out_end_date": "2017-08-16 07:45:00"
},
{
"black_out_start_date": "2017-08-16 07:45:00",
"black_out_end_date": "2017-08-16 07:45:00"
},
{
"black_out_start_date": "2017-09-28 10:31:54",
"black_out_end_date": "2017-09-28 10:31:54"
} ],
"note": "test notes",
"offer_status": 1,
"currency": { "custom_currency": 1,
"currency_code": "INR"
},
"payout_type": "commission",
"payout": 4,
"goals": {
"multiple_conversion_goal": 1,
"default_goal_name": "install",
"additional_goal": [
{
"goal_name": "registration",
"payout": "2",
"cap": [
{
"daily": 180,
"overall": 300
}
]
},
{
"goal_name": "OTP",
"payout": "2",
"cap": [
{
"daily": 120,
"overall": 200
}
]
}
]
},
"cap": {
"daily": "180",
"overall": "500"
},
"tracking": {
"secure_tracking_link": 1
},
"targeting": {
"targeting_all_device_browsers": "1",
"device": "",
"browser": "",
"country": "India, Singapore",
"state": "",
"city": "",
"os": "",
"carrier": "",
"network_type": ""
}
}
],
"total": 79,
"result": {
"status_code": 0,
"timestamp": "2017-12-10 06:44:01",
"status_message": "Offers populated successfully"
}
}

Error:

{ "result":
{ "status_code": 86,
"timestamp": "2018-12-20 11:38:44",
"status_message": "Invalid key!" }
}

Updated on March 29, 2019

Was this article helpful?

Leave a Comment