لینک‌ها

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

نقطه پایانی API

GET 
https://je7.ir/api/v1/links

نمونه درخواست 

curl --location --request GET 'https://je7.ir/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parameters

نام
نوع
توضیحات
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://je7.ir/api/v1/links/{id}

نمونه درخواست 

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

نقطه پایانی API

POST 
https://je7.ir/api/v1/links

نمونه درخواست 

curl --location --request POST 'https://je7.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}'

Parameters

نام
نوع
توضیحات
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-dTH:i:s.
active_period_end_at
اختیاری string
تاریخ پایان دوره فعال به فرمت Y-m-dTH:i:s.
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 باشد.

برای targets_type=operating_systems، مقادیر احتمالی عبارتند از: 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://je7.ir/api/v1/links/{id}

نمونه درخواست 

curl --location --request PUT 'https://je7.ir/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Parameters

نام
نوع
توضیحات
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-dTH:i:s.
active_period_end_at
اختیاری string
تاریخ پایان دوره فعال به فرمت Y-m-dTH:i:s.
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 باشد.

برای targets_type=operating_systems، مقادیر احتمالی عبارتند از: 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://je7.ir/api/v1/links/{id}

نمونه درخواست 

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