رفتن به محتوا
مستندات API

لینک‌ها

لینک‌های کوتاه خود، قوانین هدف‌گیری، پیکسل‌ها و تغییر مسیرها را ایجاد و مدیریت کنید.

احراز هویت
هر درخواست باید هدر Authorization را با توکن Bearer مطابق با کلید API مدیریت ارسال کند. دریافت کلید API.
مستندات API

نقطه پایانی
GET https://rqrcode.com/api/links/
مثال
curl --request GET \
--url 'https://rqrcode.com/api/links/' \
--header 'Authorization: Bearer {api_key}'
پارامترها
پارامترها جزئیات توضیحات
page
اختیاری ui.admin.api_docs.common.types.عدد صحیح
شماره صفحه‌ای که می‌خواهید نتایج آن را دریافت کنید. به طور پیش‌فرض 1 است.
results_per_page
اختیاری ui.admin.api_docs.common.types.عدد صحیح
چند نتیجه در هر صفحه می‌خواهید. مقادیر مجاز عبارتند از: 10، 25، 50، 100، 250، 500، 1000. به طور پیش‌فرض 25 است.
نمونه پاسخ
{
    "data": [
        {
            "id": 1,
            "project_id": null,
            "domain_id": 0,
            "type": "link",
            "url": "نمونه",
            "location_url": "https://example.com/",
            "settings": {
                "password": null,
                "sensitive_content": false
            },
            "pageviews": 10,
            "order": 0,
            "start_date": null,
            "end_date": null,
            "datetime": "2026-04-20 07:53:23"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://rqrcode.com/api/links?page=1",
        "last": "https://rqrcode.com/api/links?page=1",
        "next": null,
        "prev": null,
        "self": "https://rqrcode.com/api/links?page=1"
    }
}

نقطه پایانی
GET https://rqrcode.com/api/links/{link_id}
مثال
curl --request GET \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
پارامترها
پارامتر اضافی ندارد.
نمونه پاسخ
{
    "data": {
        "id": 1,
        "project_id": null,
        "domain_id": 0,
        "type": "link",
        "url": "نمونه",
        "location_url": "https://example.com/",
        "settings": {
            "password": null,
            "sensitive_content": false
        },
        "pageviews": 10,
        "order": 0,
        "start_date": null,
        "end_date": null,
        "datetime": "2026-04-20 07:53:23"
    }
}

نقطه پایانی
POST https://rqrcode.com/api/links
مثال
curl --request POST \
--url 'https://rqrcode.com/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=نمونه' \
--form 'location_url=https://rqrcode.com/'
پارامترها
پارامترها جزئیات توضیحات
location_url
الزامی ui.admin.api_docs.common.types.رشته
آدرس مقصد. در دسترس زمانی که: is_bulk = 0
location_urls
الزامی ui.admin.api_docs.common.types.رشته
آدرس مقصد. در دسترس زمانی که: is_bulk = 1
url
اختیاری ui.admin.api_docs.common.types.رشته
نام مستعار URL تولید شده. برای یک نام تصادفی خالی بگذارید. در دسترس زمانی که: is_bulk = 0
is_bulk
اختیاری ui.admin.api_docs.common.types.بولی
domain_id
اختیاری ui.admin.api_docs.common.types.عدد صحیح
project_id
اختیاری ui.admin.api_docs.common.types.عدد صحیح
pixels_ids
اختیاری ui.admin.api_docs.common.types.عدد صحیح
schedule
اختیاری ui.admin.api_docs.common.types.بولی
start_date
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: schedule = true
end_date
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: schedule = true
pageviews_limit
اختیاری ui.admin.api_docs.common.types.عدد صحیح
expiration_url
اختیاری ui.admin.api_docs.common.types.رشته
password
اختیاری ui.admin.api_docs.common.types.رشته
forward_query_parameters_is_enabled
اختیاری ui.admin.api_docs.common.types.بولی
utm_source
اختیاری ui.admin.api_docs.common.types.رشته
utm_medium
اختیاری ui.admin.api_docs.common.types.رشته
utm_campaign
اختیاری ui.admin.api_docs.common.types.رشته
sensitive_content
اختیاری ui.admin.api_docs.common.types.بولی
http_status_code
اختیاری ui.admin.api_docs.common.types.عدد صحیح
مقادیر مجاز: 301, 302, 307, 308
app_linking_is_enabled
اختیاری ui.admin.api_docs.common.types.بولی
cloaking_is_enabled
اختیاری ui.admin.api_docs.common.types.بولی
cloaking_title
اختیاری ui.admin.api_docs.common.types.رشته
cloaking_meta_description
اختیاری ui.admin.api_docs.common.types.رشته
cloaking_custom_js
اختیاری ui.admin.api_docs.common.types.رشته
cloaking_favicon
اختیاری ui.admin.api_docs.common.types.فایل
cloaking_opengraph
اختیاری ui.admin.api_docs.common.types.فایل
targeting_type
اختیاری ui.admin.api_docs.common.types.رشته
مقادیر مجاز: continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name
targeting_continent_code_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = continent_code
targeting_continent_code_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = continent_code
targeting_country_code_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = country_code
targeting_country_code_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = country_code
targeting_city_name_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = city_name
targeting_city_name_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = city_name
targeting_device_type_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = device_type
targeting_device_type_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = device_type
targeting_browser_language_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = browser_language
targeting_browser_language_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = browser_language
targeting_rotation_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = rotation
targeting_rotation_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = rotation
targeting_os_name_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = os_name
targeting_os_name_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = os_name
targeting_browser_name_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = browser_name
targeting_browser_name_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = browser_name
نمونه پاسخ
{
    "data": {
        "id": 1
    }
}

نقطه پایانی
POST https://rqrcode.com/api/links/{link_id}
مثال
curl --request POST \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0'
پارامترها
پارامترها جزئیات توضیحات
location_url
اختیاری ui.admin.api_docs.common.types.رشته
آدرس مقصد.
url
اختیاری ui.admin.api_docs.common.types.رشته
نام مستعار URL تولید شده. برای یک نام تصادفی خالی بگذارید.
domain_id
اختیاری ui.admin.api_docs.common.types.عدد صحیح
project_id
اختیاری ui.admin.api_docs.common.types.عدد صحیح
pixels_ids
اختیاری ui.admin.api_docs.common.types.عدد صحیح
schedule
اختیاری ui.admin.api_docs.common.types.بولی
start_date
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: schedule = true
end_date
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: schedule = true
pageviews_limit
اختیاری ui.admin.api_docs.common.types.عدد صحیح
expiration_url
اختیاری ui.admin.api_docs.common.types.رشته
password
اختیاری ui.admin.api_docs.common.types.رشته
forward_query_parameters_is_enabled
اختیاری ui.admin.api_docs.common.types.بولی
utm_source
اختیاری ui.admin.api_docs.common.types.رشته
utm_medium
اختیاری ui.admin.api_docs.common.types.رشته
utm_campaign
اختیاری ui.admin.api_docs.common.types.رشته
sensitive_content
اختیاری ui.admin.api_docs.common.types.بولی
http_status_code
اختیاری ui.admin.api_docs.common.types.عدد صحیح
مقادیر مجاز: 301, 302, 307, 308
app_linking_is_enabled
اختیاری ui.admin.api_docs.common.types.بولی
cloaking_is_enabled
اختیاری ui.admin.api_docs.common.types.بولی
cloaking_title
اختیاری ui.admin.api_docs.common.types.رشته
cloaking_meta_description
اختیاری ui.admin.api_docs.common.types.رشته
cloaking_custom_js
اختیاری ui.admin.api_docs.common.types.رشته
cloaking_favicon
اختیاری ui.admin.api_docs.common.types.فایل
cloaking_opengraph
اختیاری ui.admin.api_docs.common.types.فایل
targeting_type
اختیاری ui.admin.api_docs.common.types.رشته
مقادیر مجاز: continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name
targeting_continent_code_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = continent_code
targeting_continent_code_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = continent_code
targeting_country_code_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = country_code
targeting_country_code_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = country_code
targeting_city_name_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = city_name
targeting_city_name_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = city_name
targeting_device_type_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = device_type
targeting_device_type_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = device_type
targeting_browser_language_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = browser_language
targeting_browser_language_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = browser_language
targeting_rotation_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = rotation
targeting_rotation_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = rotation
targeting_os_name_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = os_name
targeting_os_name_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = os_name
targeting_browser_name_key[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = browser_name
targeting_browser_name_value[index]
اختیاری ui.admin.api_docs.common.types.رشته
در دسترس زمانی که: targeting_type = browser_name
نمونه پاسخ
{
    "data": {
        "id": 1
    }
}

نقطه پایانی
DELETE https://rqrcode.com/api/links/{link_id}
مثال
curl --request DELETE \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
پارامترها
پارامتر اضافی ندارد.
نمونه پاسخ
بدنه پاسخ 200 در حالت موفقیت خالی است.