URL for a request
Method
GET
Incoming Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| api_token | string | Yes | API token for access |
| url | string | Yes | Main offer page link |
| type | string | Yes | The type of link. Possible options:
|
| domain_id | int | Yes | Specify the ID of your or Premium domain. You can also get through the method List of domains |
| options | string | Yes | String with a list of parameters: |
| cloaking_on | int | Yes | 1 - Activate cloaking link |
| cloaking[url] | string | Yes | White Page URL |
| cloaking[mode] | int | Yes |
|
| cloaking[change_links] | int | No |
|
| cloaking[filters][] | string | Yes |
Selection of filters for checking traffic.
|
| cloaking[geo_filter_status] | int | No |
Country filtering property:
|
| cloaking[geo_filter_list] | string | No | ISO country codes for the filter in uppercase, separated by commas (US,RU,IT) |
| cloaking[ip_filter_status] | int | No |
IP filter property:
|
| cloaking[ip_filter_list] | string | No | List of IPs separated by commas. You can specify a range in the format: 200.200.50.0/255 |
| cloaking[isp_filter_status] | int | No |
Filtering property by ISP (Internet Service Providers):
|
| cloaking[isp_filter_list] | string | No | List of providers separated by commas |
| cloaking[referer_filter_status] | int | No |
Referer filtering property:
|
| cloaking[referer_filter_list] | string | No | Values in referer separated by commas |
| cloaking[ua_filter_status] | int | No |
Filtering property by User Agent:
|
| cloaking[ua_filter_list] | string | No | Values in User Agent separated by commas |
| cloaking[os_filters][] | string | No | List of OS to display White Page
|
| code | string | No | The link code. Must be unique. The Latin alphabet, numbers and underscores are allowed. |
| group_id | int | No | Link group ID |
| monetization | bool | No | Enable ad display by link or not. 0 or 1 |
| link_name | string | No | Link name |
| keywords | string | No | Keywords for link search, as well as for ad selection with monetization enabled, separated by commas |
| keywords_mode | int | No | Keyword search logic: 1 - any word, 2 - half of the words, 3 - all the words from the query must be taken into account |
Return values
The server returns a response in JSON format. The list of parameters depends on the server response code:
Request example
API
curl 'https://firelinks.cc/api/out/links/create?api_token=W9DtD7JtyHI7nPj8eEWul2pVkcobE62IHaHi3n8ClQdogBGZe6n70fIgTH3u&type=url&link_name=API test&url=https://cupi.me&domain_id=16&options=cloaking_on=1&cloaking[url]=http://google.com&cloaking[filters][]=cuti&cloaking[filters][]=ipv6&cloaking[mode]=1'
Response example 200
{
"success": true,
"id": 412,
"url": "https://firelinks.cc/Test_code_1",
"qr": "https://cuti.cc/qr.png",
"title": "The domain was successfully connected",
"description": null
}
Response example 422
{
"success": false,
"errors": "Validation errors",
"data": {
"code": [
"This link code is already occupied"
]
}
}
