لینک‌ها

یادداشت‌ها
سطح تخصصی
کلید API باید به عنوان توکن Bearer در هدر Authorization درخواست ارسال شود. دریافت کلید API شما.
فهرست

نقطه پایانی API:

GET 
https://5li.ir/api/v1/links

مثال درخواست: 

curl --location --request GET 'https://5li.ir/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
توضیحات
search
اختیاری string
عبارت جستجو.
search_by
اختیاری string
جستجو بر اساس. مقادیر ممکن عبارتند از: title برای عنوان, alias برای نام مستعار, url برای آدرس. پیش‌فرض: title.
status
اختیاری integer
وضعیت. مقادیر ممکن عبارتند از: 0 برای همه, 1 برای فعال, 2 برای منقضی شده, 3 برای غیرفعال. پیش‌فرض: 0.
space_id
اختیاری integer
شناسه فضای کاری.
domain_id
اختیاری integer
شناسه دامنه.
pixel_id
اختیاری integer
شناسه پیکسل.
sort_by
اختیاری string
مرتب‌سازی بر اساس. مقادیر ممکن عبارتند از: id برای تاریخ ایجاد, clicks برای کلیک‌ها, title برای عنوان, alias برای نام مستعار, url برای آدرس. پیش‌فرض: id.
sort
اختیاری string
مرتب‌سازی. مقادیر ممکن عبارتند از: desc برای نزولی, asc برای صعودی. پیش‌فرض: desc.
per_page
اختیاری integer
نتایج در هر صفحه. مقادیر ممکن عبارتند از: 10, 25, 50, 100. پیش‌فرض: 10.
نمایش

نقطه پایانی API:

GET 
https://5li.ir/api/v1/links/{id}

مثال درخواست: 

curl --location --request GET 'https://5li.ir/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
ذخیره

نقطه پایانی API:

POST 
https://5li.ir/api/v1/links

مثال درخواست: 

curl --location --request POST 'https://5li.ir/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
پارامتر
نوع
توضیحات
url
الزامی string
آدرس مقصد.
domain_id
الزامی integer
شناسه دامنه.
alias
اختیاری string
نام مستعار.
space_id
اختیاری integer
شناسه فضای کاری.
pixel_ids[]
اختیاری array
شناسه‌های پیکسل.
redirect_password
اختیاری string
رمز عبور هدایت.
sensitive_content
اختیاری integer
محتوای حساس. مقادیر ممکن عبارتند از: 0 برای خیر, 1 برای بله. پیش‌فرض: 0.
privacy
اختیاری integer
حریم خصوصی آمار. مقادیر ممکن عبارتند از: 0 برای عمومی, 1 برای خصوصی, 2 برای رمز عبور. پیش‌فرض: 0.
password
اختیاری string
رمز عبور آمار. فقط زمانی کار می‌کند که فیلد privacy روی 2 تنظیم شده باشد.
active_period_start_at
اختیاری string
تاریخ شروع دوره فعال در قالب Y-m-d H:i.
active_period_end_at
اختیاری string
تاریخ پایان دوره فعال در قالب Y-m-d H:i.
clicks_limit
اختیاری integer
محدودیت کلیک.
expiration_url
اختیاری string
آدرس انقضا.
targets_type
اختیاری string
هدف‌گیری. مقادیر ممکن عبارتند از: continents برای Continents, countries برای Countries, operating_systems برای Operating systems, browsers برای Browsers, languages برای Languages, devices برای Devices, rotations برای Rotations.
targets[index][key]
اختیاری string
برای targets_type=country، مقدار باید در قالب ISO 3166-1 alpha-2 باشد.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
برای targets_type=browsers، مقادیر ممکن عبارتند از: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
برای targets_type=devices، مقادیر ممکن عبارتند از: Desktop, Mobile, Tablet, Watch, Television.
برای targets_type=languages، مقدار باید در قالب ISO 639-1 alpha-2 باشد.
برای targets_type=continents، مقادیر ممکن عبارتند از: AF برای Africa, AN برای Antarctica, AS برای Asia, EU برای Europe, NA برای North America, OC برای Oceania, SA برای South America.
targets[index][value]
اختیاری string
آدرس مقصد.
به‌روزرسانی

نقطه پایانی API:

PUT PATCH 
https://5li.ir/api/v1/links/{id}

مثال درخواست: 

curl --location --request PUT 'https://5li.ir/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
پارامتر
نوع
توضیحات
url
اختیاری string
آدرس مقصد.
alias
اختیاری string
نام مستعار.
space_id
اختیاری integer
شناسه فضای کاری.
pixel_ids[]
اختیاری array
شناسه‌های پیکسل.
redirect_password
اختیاری string
رمز عبور هدایت.
sensitive_content
اختیاری integer
محتوای حساس. مقادیر ممکن عبارتند از: 0 برای خیر, 1 برای بله.
privacy
اختیاری integer
حریم خصوصی آمار. مقادیر ممکن عبارتند از: 0 برای عمومی, 1 برای خصوصی, 2 برای رمز عبور.
password
اختیاری string
رمز عبور آمار. فقط زمانی کار می‌کند که فیلد privacy روی 2 تنظیم شده باشد.
active_period_start_at
اختیاری string
تاریخ شروع دوره فعال در قالب Y-m-d H:i.
active_period_end_at
اختیاری string
تاریخ پایان دوره فعال در قالب Y-m-d H:i.
clicks_limit
اختیاری integer
محدودیت کلیک.
expiration_url
اختیاری string
آدرس انقضا.
targets_type
اختیاری string
هدف‌گیری. مقادیر ممکن عبارتند از: continents برای Continents, countries برای Countries, operating_systems برای Operating systems, browsers برای Browsers, languages برای Languages, devices برای Devices, rotations برای Rotations.
targets[index][key]
اختیاری string
برای targets_type=country، مقدار باید در قالب ISO 3166-1 alpha-2 باشد.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
برای targets_type=browsers، مقادیر ممکن عبارتند از: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
برای targets_type=devices، مقادیر ممکن عبارتند از: Desktop, Mobile, Tablet, Watch, Television.
برای targets_type=languages، مقدار باید در قالب ISO 639-1 alpha-2 باشد.
برای targets_type=continents، مقادیر ممکن عبارتند از: AF برای Africa, AN برای Antarctica, AS برای Asia, EU برای Europe, NA برای North America, OC برای Oceania, SA برای South America.
targets[index][value]
اختیاری string
آدرس مقصد.
حذف

نقطه پایانی API:

DELETE 
https://5li.ir/api/v1/links/{id}

مثال درخواست: 

curl --location --request DELETE 'https://5li.ir/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'