API



Commands

Note: required parameters are marked with blue.


Create campaign / Update campaign
https://api.riblink.com/en/request/json/campaigns/create
If no campaign_id is specified, then a new campaign will be created. If campaign_id is specified, updates the campaign data. Returns campaign data that was created/updated

Parameters:
  • title - Campaign name
  • campaign_id - Campaign ID if you want to update the data of a previously created campaign
  • links_type - Links type: 0 - key only (default), 1 - key and URL part
  • ads_type - Ads type: 0 - no ads, 1 - loading page (default)
  • ads_popunder - Enable popunder/clickunder (default is OFF)
  • ads_adult - Allow adult ads (default is ON)
  • ads_interval - Ads frequency (sec.): 0 - no limits (default), 3600 - once per hour, 86400 - once per day
  • show_dest_url - Show the destination URL to the client (default is ON)
  • links_title - Title for all links
  • links_description - Description
  • links_button - Button caption
  • public_stat - Public statistics on the links
  • password - URL password
  • password_confirm - Confirm password
  • domain_id - The domain ID you previously connected. All campaign links will use this domain

Response example:
{
	"result": true,
	"data": {
		"id": 521,
		"title": "My new campaign",
		"type": "manual",
		"status": "active",
		"ads_type": 0,
		"ads_popunder": 1,
		"ads_adult": 0,
		"ads_interval": 0,
		"links_type": 0,
		"show_dest_url": 0,
		"links_title": "",
		"links_description": "",
		"links_button": "",
		"has_links_password": true,
		"domain": "https://rib.li",
		"public_stat": 0,
		"urls_amount": 0,
		"created": "2017-09-15 20:38:54"
	}
}
							
Get campaign data
https://api.riblink.com/en/request/json/campaigns/get
Parameters:
  • campaign_id - Campaign ID

Response example:
{
	"result": true,
	"data": {
		"id": 521,
		"title": "My new campaign",
		"type": "manual",
		"status": "active",
		"ads_type": 0,
		"ads_popunder": 1,
		"ads_adult": 0,
		"ads_interval": 0,
		"links_type": 0,
		"show_dest_url": 0,
		"links_title": "",
		"links_description": "",
		"links_button": "",
		"has_links_password": true,
		"domain": "https://rib.li",
		"public_stat": 0,
		"urls_amount": 0,
		"created": "2017-09-15 20:38:54"
	}
}
							
Delete campaign
https://api.riblink.com/en/request/json/campaigns/delete
Parameters:
  • campaign_id - Campaign ID

Response example:
{
	"result": true
}
							
Create link / Update link
https://api.riblink.com/en/request/json/campaigns/links/create
If no link_id is specified, then a new link will be created. If link_id is specified, updates the existing link data. Returns link data that was created/updated

Parameters:
  • url - URL to be converted
  • link_id - Link ID if you want to update an existing link
  • campaign_id - Campaign ID to which the link will be added (only when creating a new link). If not specified - the link will be added to the default campaign
  • url_key - The key of the link (part the short link ends with). If not specified, random will be created
  • title - Link title
  • description - Link description
  • button - Button caption
  • comment - Add notes to the URL (only you can see it)

Response example:
{
	"result": true
}
							
Get link data
https://api.riblink.com/en/request/json/campaigns/links/get
Finds the link by link_id or url_key and returns its data. Shows the data only for your own links.

Parameters:
  • link_id - Link ID
  • url_key - The key of the link (part the short link ends with)

Response example:
{
	"result": true,
	"data": {
		"id": 36523,
		"campaign_id": 521,
		"campaign_title": "My new campaign",
		"url_key": "bx5i",
		"url": "https://riblink.com/index/rules",
		"title": "",
		"description": "",
		"button": "",
		"comment": "",
		"created": "2017-09-16 13:23:24"
	}
}
							
Delete link
https://api.riblink.com/en/request/json/campaigns/links/delete
Parameters:
  • link_id - Link ID

Response example:
{
	"result": true
}
							
By using this website, you consent to the use of cookies to ensure the functionality of the site and make it convenient for you. More about cookies you can read here
Agree