صفحه‌های اسپلش

دریافت همه

GET https://linkcomposer.com/api/splash-pages/
curl --request GET \
--url 'https://linkcomposer.com/api/splash-pages/' \
--header 'Authorization: Bearer {api_key}' \
پارامترها جزئیات توضیحات
search اختیاری رشته (String) عبارت جستجو.
search_by اختیاری رشته (String) فیلدی که بر اساس آن جستجو می‌کنید. مقادیر مجاز: name.
datetime_field اختیاری رشته (String) مقادیر مجاز: datetime, last_datetime
datetime_start اختیاری رشته (String) فیلتر نتایج از این تاریخ و زمان به بعد. با قالب Y-m-d H:i:s.
datetime_end اختیاری رشته (String) فیلتر نتایج تا این تاریخ و زمان. با قالب Y-m-d H:i:s.
order_by اختیاری رشته (String) فیلدی که نتایج بر اساس آن مرتب می‌شوند. مقادیر مجاز: splash_page_id, datetime, last_datetime, name.
order_type اختیاری رشته (String) ترتیب نتایج. مقادیر مجاز: ASC برای ترتیب صعودی و DESC برای ترتیب نزولی.
page اختیاری عدد صحیح (Integer) شماره صفحه‌ای که می‌خواهید نتایج آن را دریافت کنید. مقدار پیش‌فرض 1 است.
results_per_page اختیاری عدد صحیح (Integer) تعداد نتایج در هر صفحه. مقادیر مجاز: 10, 25, 50, 100, 250, 500, 1000. مقدار پیش‌فرض 25 است. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "name": "Example",
            "title": "Example",
            "description": "Example",
            "link_unlock_seconds": "Example",
            "auto_redirect": true,
            "settings": [],
            "last_datetime": null,
            "datetime": "2026-10-03 00:02:38"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://linkcomposer.com/api/splash-pages?page=1",
        "last": "https://linkcomposer.com/api/splash-pages?page=1",
        "next": null,
        "prev": null,
        "self": "https://linkcomposer.com/api/splash-pages?page=1"
    }
}

دریافت یک مورد

GET https://linkcomposer.com/api/splash-pages/{splash_page_id}
curl --request GET \
--url 'https://linkcomposer.com/api/splash-pages/{splash_page_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example",
        "title": "Example",
        "description": "Example",
        "link_unlock_seconds": "Example",
        "auto_redirect": true,
        "settings": [],
        "last_datetime": null,
        "datetime": "2026-10-03 00:02:38"
    }
}

ایجاد

POST https://linkcomposer.com/api/splash-pages
پارامترها جزئیات توضیحات
name الزامی رشته (String) -
title اختیاری رشته (String) -
logo اختیاری فایل -
favicon اختیاری فایل -
opengraph اختیاری فایل -
description اختیاری رشته (String) -
secondary_button_name اختیاری رشته (String) -
secondary_button_url اختیاری رشته (String) -
custom_css اختیاری رشته (String) -
custom_js اختیاری رشته (String) -
ads_header اختیاری رشته (String) -
ads_footer اختیاری رشته (String) -
link_unlock_seconds اختیاری عدد صحیح (Integer) -
auto_redirect اختیاری بولین (Boolean) -
curl --request POST \
--url 'https://linkcomposer.com/api/projects' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Sample splash page' \
--form 'title=Custom splash page title' \
--form 'description=Custom splash page description' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example",
        "title": "Example",
        "description": "Example",
        "link_unlock_seconds": "Example",
        "auto_redirect": true,
        "settings": [],
        "last_datetime": null,
        "datetime": "2026-10-03 00:02:38"
    }
}

به‌روزرسانی

POST https://linkcomposer.com/api/splash-pages/{splash_page_id}
پارامترها جزئیات توضیحات
name اختیاری رشته (String) -
title اختیاری رشته (String) -
logo اختیاری فایل -
favicon اختیاری فایل -
opengraph اختیاری فایل -
description اختیاری رشته (String) -
secondary_button_name اختیاری رشته (String) -
secondary_button_url اختیاری رشته (String) -
custom_css اختیاری رشته (String) -
custom_js اختیاری رشته (String) -
ads_header اختیاری رشته (String) -
ads_footer اختیاری رشته (String) -
link_unlock_seconds اختیاری عدد صحیح (Integer) -
auto_redirect اختیاری بولین (Boolean) -
curl --request POST \
--url 'https://linkcomposer.com/api/splash-pages/{splash_page_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Sample splash page' \
--form 'title=Custom splash page title' \
--form 'description=Custom splash page description' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example",
        "title": "Example",
        "description": "Example",
        "link_unlock_seconds": "Example",
        "auto_redirect": true,
        "settings": [],
        "last_datetime": null,
        "datetime": "2026-10-03 00:02:38"
    }
}

حذف

DELETE https://linkcomposer.com/api/splash-pages/{splash_page_id}
curl --request DELETE \
--url 'https://linkcomposer.com/api/splash-pages/{splash_page_id}' \
--header 'Authorization: Bearer {api_key}' \