وب سایت ها

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

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

GET 
https://zlin.ir/api/v1/websites

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

curl --location --request GET 'https://zlin.ir/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
تایپ
توضیحات
search
اختیاری string
عبارت جستجو
search_by
اختیاری string
جستجو بر اساس. مقادیر ممکن عبارتند از: domain برای دامنه. پیش‌فرض: domain.
favorite
اختیاری boolean
فیلتر بر اساس دلخواه.
sort_by
اختیاری string
مرتب سازی بر اساس. مقادیر ممکن عبارتند از: id برای تاریخ ایجاد, domain برای دامنه. پیش‌فرض: id.
sort
اختیاری string
مرتب کردن. مقادیر ممکن عبارتند از: desc برای نزولی, asc برای صعودی. پیش‌فرض: desc.
per_page
اختیاری integer
نتایج در هر صفحه. مقادیر ممکن عبارتند از: 10, 25, 50, 100. پیش‌فرض: 10.
نمایش دهید

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

GET 
https://zlin.ir/api/v1/websites/{id}

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

curl --location --request GET 'https://zlin.ir/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
فروشگاه

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

POST 
https://zlin.ir/api/v1/websites

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

curl --location --request POST 'https://zlin.ir/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
پارامتر
تایپ
توضیحات
domain
مورد نیاز string
نام دامنه.
privacy
اختیاری integer
حریم خصوصی صفحه آمار مقادیر ممکن عبارتند از: 0 برای عمومی, 1 برای خصوصی, 2 برای رمزعبور. پیش‌فرض: 0.
password
اختیاری string
رمز عبور صفحه آمار فقط با فیلد که روی 2 تنظیم شده است کار می کند.
email
اختیاری integer
گزارش های ایمیل دوره ای. مقادیر ممکن عبارتند از: 0 برای از کار افتاده است, 1 برای فعال شد. پیش‌فرض: 0.
exclude_bots
اختیاری integer
ربات های رایج را از ردیابی حذف کنید. مقادیر ممکن عبارتند از: 0 برای از کار افتاده است, 1 برای فعال شد. پیش‌فرض: 1.
exclude_params
اختیاری string
Exclude URL query parameters from being tracked. هر خط یکی.
exclude_ips
اختیاری string
IP ها را از ردیابی حذف کنید. هر خط یکی.
بروزرسانی

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

PUT PATCH 
https://zlin.ir/api/v1/websites/{id}

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

curl --location --request PUT 'https://zlin.ir/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
پارامتر
تایپ
توضیحات
privacy
اختیاری integer
حریم خصوصی صفحه آمار مقادیر ممکن عبارتند از: 0 برای عمومی, 1 برای خصوصی, 2 برای رمزعبور.
password
اختیاری string
رمز عبور صفحه آمار فقط با فیلد که روی 2 تنظیم شده است کار می کند.
email
اختیاری integer
گزارش های ایمیل دوره ای. مقادیر ممکن عبارتند از: 0 برای از کار افتاده است, 1 برای فعال شد.
exclude_bots
اختیاری integer
ربات های رایج را از ردیابی حذف کنید. مقادیر ممکن عبارتند از: 0 برای از کار افتاده است, 1 برای فعال شد.
exclude_params
اختیاری string
Exclude URL query parameters from being tracked. هر خط یکی.
exclude_ips
اختیاری string
IP ها را از ردیابی حذف کنید. هر خط یکی.
favorite
اختیاری boolean
این که آیا وب سایت مورد علاقه است یا خیر.
حذف

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

DELETE 
https://zlin.ir/api/v1/websites/{id}

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

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