Superlinks API V1

The Superlinks API is the programming interface to Superlinks. You can use the API to integrate your app or website with the Superlinks display ad publishing network and help elevate your ad revenue.


1. Authorization Key Requests

If you are interested in obtaining an authorization key to use the Superlinks API, please Contact Us. If you already have an authorization key and are having problems with access, please submit a ticket at http://support.superlinks.com/.


2. Rest API Methods

There are six API calls you can make with the Superlinks API:

  • getSites
  • getWidgets
  • getWidgetsBySiteId
  • getStats
  • getGoogleLink
  • getReferralLink

Responses to API calls are represented using JSON data formats.


2.1. Get Sites

This getSites API call returns a list of ids and names from all approved sites for the selected user.

Request:

Method: GET

URL: http(s)://api.superlinks.com/api/v1/getSites

Parameter Description Type
authkey Authentication key String

Example:

URL: http(s)://api.superlinks.com/api/v1/getSites?authkey=5f4dcc3b5aa765d61d8327deb882cf99

Response:
Body: {
	"success": true,
	"items": [{
		"id": 10001,
		"name": "foo.example.com"
	},
	{
		"id": 10002,
		"name": "bar.example.com"
	}]
}

2.2. Get Widgets

This getWidgets API call returns a list of ids, site ids, names, product types, and banner sizes from all approved widgets for the selected user.

Request:

Method: GET

URL: http(s)://api.superlinks.com/api/v1/getWidgets

Parameter Description Type
authkey Authentication key String

Example:

URL: http(s)://api.superlinks.com/api/v1/getWidgets?authkey=5f4dcc3b5aa765d61d8327deb882cf99

Response:
Status: 200
Body: {
	"success": true,
	"items": [{
		"id": 1,
		"site_id": 1,
		"name": "test superlinks 1",
		"product_type": "Super Display Ads",
		"banner_size": "320x240"
	},
	{
		"id": 2,
		"site_id": 2,
		"name": "test superlinks 2",
		"product_type": "Super Footer",
		"banner_size": "720x80"
	}]
}

2.3. Get Widgets by Site ID

This getWidgetsBySiteId API call returns a list of ids, site ids, names, product types, and banner sizes for all approved widgets for the designated site for the selected user.

Request:

Method: GET

URL: http(s)://api.superlinks.com/api/v1/getWidgetsBySiteId

Parameter Description Type
site_id Site identifier Number
authkey Authentication key String

Example:

URL:http(s)://api.superlinks.com/api/v1/getWidgetsBySiteId?authkey=5f4dcc3b5aa765d61d8327deb882cf99&site_id=1001011

Response:
Status: 200
Body: {
	"success": true,
	"items": [{
		"id": 1,
		"site_id": 1,
		"name": "test superlinks 1",
		"product_type": "Super Display Ads",
		"banner_size": "320x240"
	}]
}

2.4. Statistics

The getStats API call returns the earning by period for the selected user.

Request:

Method: GET

URL: http(s)://api.superlinks.com/api/v1/getStats

Parameter Description Type
authkey Authentication key String

Example:

URL: http(s)://api.superlinks.com/api/v1/getStats?authkey=5f4dcc3b5aa765d61d8327deb882cf99

Response:
Status: 200
Body: {
	"success": true,
	"earnings": {
		"yesterday": "$3,413.36",
		"weekly": "$9,428.03",
		"monthly": "$9,117.27",
		"last_month": "$731.41",
		"total": "$9,848.68"
	}
}

2.5. Google Signup Link

This getGoogleLink API call returns the Google Ad Exchange signup link for the selected user.

Request:

Method: GET

URL: http(s)://api.superlinks.com/api/v1/getGoogleLink

Parameter Description Type
authkey Authentication key String

Example:

URL: http(s)://api.superlinks.com/api/v1/getGoogleLink?authkey=5f4dcc3b5aa765d61d8327deb882cf99

Response:
Status: 200
Body: {
	"success": true,
	"google_url": http: //google.com/signup?23543647474
}

2.6. Referral Signup Link

This getReferralLink API call returns the referral signup link for the selected user.

Request:

Method: GET

URL: http(s)://api.superlinks.com/api/v1/getReferralLink

Parameter Description Type
authkey Authentication key String

Example:

URL: http(s)://api.superlinks.com/api/v1/getReferralLink?authkey=5f4dcc3b5aa765d61d8327deb882cf99

Response:
Status: 200
Body: {
	"success": true,
	"referral_url": "https://www.superlinks.com/publisher/signup/ref?121212"
}

2.7. Bad Authorization Key

If the specified authorization key is ever invalid, the response status code will be 403 with the success value as false. The accompanying message will give the reason why access failed.

Request:

Method: GET

URL: http(s)://api.superlinks.com/api/v1/getReferralLink

Parameter Description Type
authkey Authentication key String

Example:

URL: http(s)://api.superlinks.com/api/v1/getReferralLink?authkey=5f4dcc3b5aa765d61d8327deb882cf99

Response:
Status: 403
Body: {
	"success": false,
	"message": "Access denied"
}