وبسایت‌ها

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

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

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

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

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

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

DELETE 
https://checkmysite.ir/api/v1/websites/{website}

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

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