لینک ها
GET https://url20.ir/api/links/
curl --request GET \
--url 'https://url20.ir/api/links/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://url20.ir/api/links/' \
--header 'Authorization: Bearer {api_key}' \
| پارامترها | Details | Description |
|---|---|---|
| page | اختیاری عدد صحیح | شماره صفحه ای که می خواهید از آن نتیجه بگیرید. پیش‌فرض 1. |
| results_per_page | اختیاری عدد صحیح | در هر صفحه چند نتیجه می خواهید. مقادیر مجاز عبارتند از: 10 , 25 , 50 , 100 , 250 , 500 , 1000. پیش‌فرض 25. |
{
"data": [
{
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "example",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"clicks": 10,
"order": 0,
"start_date": null,
"end_date": null,
"datetime": "2025-11-19 10:28:13",
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://url20.ir/api/links?page=1",
"last": "https://url20.ir/api/links?page=1",
"next": null,
"prev": null,
"self": "https://url20.ir/api/links?page=1"
}
}
GET https://url20.ir/api/links/{link_id}
curl --request GET \
--url 'https://url20.ir/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://url20.ir/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "example",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"clicks": 10,
"order": 0,
"start_date": null,
"end_date": null,
"datetime": "2025-11-19 10:28:13",
}
}
POST https://url20.ir/api/links
| پارامترها | Details | Description |
|---|---|---|
| type | اختیاری رشته | link |
| location_url | ضروری رشته | نشانی اینترنتی مقصد.Available when: is_bulk = 0 |
| location_urls | ضروری رشته | نشانی اینترنتی مقصد.Available when: is_bulk = 1 |
| url | اختیاری رشته | نام مستعار آدرس لینک تولید شده. برای یکی که به طور تصادفی تولید شده است, خالی بگذارید.Available when: is_bulk = 0 |
| is_bulk | اختیاری بولی | |
| domain_id | اختیاری عدد صحیح | - |
| project_id | اختیاری عدد صحیح | - |
| pixels_ids | اختیاری آرایه عدد صحیح | - |
| email_reports | اختیاری آرایه | Notification handler ids |
| schedule | اختیاری بولی | - |
| start_date | اختیاری رشته | Available when: schedule = true |
| end_date | اختیاری رشته | Available when: schedule = true |
| clicks_limit | اختیاری عدد صحیح | - |
| expiration_url | اختیاری رشته | - |
| sensitive_content | اختیاری بولی | - |
| http_status_code | اختیاری عدد صحیح | مقادیر مجاز: 301, 302, 307, 308 |
| app_linking_is_enabled | اختیاری بولی | - |
| cloaking_is_enabled | اختیاری بولی | - |
| cloaking_title | اختیاری رشته | - |
| cloaking_meta_description | اختیاری رشته | - |
| cloaking_custom_js | اختیاری رشته | - |
| cloaking_favicon | اختیاری پرونده | - |
| cloaking_opengraph | اختیاری پرونده | - |
| password | اختیاری رشته | - |
| forward_query_parameters_is_enabled | اختیاری بولی | - |
| utm_source | اختیاری رشته | - |
| utm_medium | اختیاری رشته | - |
| utm_campaign | اختیاری رشته | - |
| targeting_type | اختیاری رشته | continent_code , country_code , device_type , browser_language , rotation , os_name , browser_name |
| targeting_continent_code_key[index] | اختیاری رشته | Available when: targeting_type = continent_code |
| targeting_continent_code_value[index] | اختیاری رشته | Available when: targeting_type = continent_code |
| targeting_country_code_key[index] | اختیاری رشته | Available when: targeting_type = country_code |
| targeting_country_code_value[index] | اختیاری رشته | Available when: targeting_type = country_code |
| targeting_city_name_key[index] | اختیاری رشته | Available when: targeting_type = city_name |
| targeting_city_name_value[index] | اختیاری رشته | Available when: targeting_type = city_name |
| targeting_device_type_key[index] | اختیاری رشته | Available when: targeting_type = device_type |
| targeting_device_type_value[index] | اختیاری رشته | Available when: targeting_type = device_type |
| targeting_browser_language_key[index] | اختیاری رشته | Available when: targeting_type = browser_language |
| targeting_browser_language_value[index] | اختیاری رشته | Available when: targeting_type = browser_language |
| targeting_rotation_key[index] | اختیاری رشته | Available when: targeting_type = rotation |
| targeting_rotation_value[index] | اختیاری رشته | Available when: targeting_type = rotation |
| targeting_os_name_key[index] | اختیاری رشته | Available when: targeting_type = os_name |
| targeting_os_name_value[index] | اختیاری رشته | Available when: targeting_type = os_name |
| targeting_browser_name_key[index] | اختیاری رشته | Available when: targeting_type = browser_name |
| targeting_browser_name_value[index] | اختیاری رشته | Available when: targeting_type = browser_name |
curl --request POST \
--url 'https://url20.ir/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://url20.ir/' \
--url 'https://url20.ir/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://url20.ir/' \
{
"data": {
"id": 1
}
}
POST https://url20.ir/api/links/{link_id}
| پارامترها | Details | Description |
|---|---|---|
| location_url | اختیاری رشته | نشانی اینترنتی مقصد. |
| url | اختیاری رشته | نام مستعار آدرس لینک تولید شده. برای یکی که به طور تصادفی تولید شده است, خالی بگذارید. |
| domain_id | اختیاری عدد صحیح | - |
| project_id | اختیاری عدد صحیح | - |
| pixels_ids | اختیاری آرایه عدد صحیح | - |
| email_reports | اختیاری آرایه | Notification handler ids |
| schedule | اختیاری بولی | - |
| start_date | اختیاری رشته | Available when: schedule = true |
| end_date | اختیاری رشته | Available when: schedule = true |
| clicks_limit | اختیاری عدد صحیح | - |
| expiration_url | اختیاری رشته | - |
| sensitive_content | اختیاری بولی | - |
| http_status_code | اختیاری عدد صحیح | مقادیر مجاز: 301, 302, 307, 308 |
| app_linking_is_enabled | اختیاری بولی | - |
| cloaking_is_enabled | اختیاری بولی | - |
| cloaking_title | اختیاری رشته | - |
| cloaking_meta_description | اختیاری رشته | - |
| cloaking_custom_js | اختیاری رشته | - |
| cloaking_favicon | اختیاری پرونده | - |
| cloaking_opengraph | اختیاری پرونده | - |
| password | اختیاری رشته | - |
| forward_query_parameters_is_enabled | اختیاری بولی | - |
| utm_source | اختیاری رشته | - |
| utm_medium | اختیاری رشته | - |
| utm_campaign | اختیاری رشته | - |
| targeting_type | اختیاری رشته | continent_code , country_code , device_type , browser_language , rotation , os_name , browser_name |
| targeting_continent_code_key[index] | اختیاری رشته | Available when: targeting_type = continent_code |
| targeting_continent_code_value[index] | اختیاری رشته | Available when: targeting_type = continent_code |
| targeting_country_code_key[index] | اختیاری رشته | Available when: targeting_type = country_code |
| targeting_country_code_value[index] | اختیاری رشته | Available when: targeting_type = country_code |
| targeting_city_name_key[index] | اختیاری رشته | Available when: targeting_type = city_name |
| targeting_city_name_value[index] | اختیاری رشته | Available when: targeting_type = city_name |
| targeting_device_type_key[index] | اختیاری رشته | Available when: targeting_type = device_type |
| targeting_device_type_value[index] | اختیاری رشته | Available when: targeting_type = device_type |
| targeting_browser_language_key[index] | اختیاری رشته | Available when: targeting_type = browser_language |
| targeting_browser_language_value[index] | اختیاری رشته | Available when: targeting_type = browser_language |
| targeting_rotation_key[index] | اختیاری رشته | Available when: targeting_type = rotation |
| targeting_rotation_value[index] | اختیاری رشته | Available when: targeting_type = rotation |
| targeting_os_name_key[index] | اختیاری رشته | Available when: targeting_type = os_name |
| targeting_os_name_value[index] | اختیاری رشته | Available when: targeting_type = os_name |
| targeting_browser_name_key[index] | اختیاری رشته | Available when: targeting_type = browser_name |
| targeting_browser_name_value[index] | اختیاری رشته | Available when: targeting_type = browser_name |
curl --request POST \
--url 'https://url20.ir/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
--url 'https://url20.ir/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
"data": {
"id": 1
}
}
DELETE https://url20.ir/api/links/{link_id}
curl --request DELETE \
--url 'https://url20.ir/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://url20.ir/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \