گزارش‌ها

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

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

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

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

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

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

GET 
https://checkmysite.ir/api/v1/reports/{id}

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

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

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

POST 
https://checkmysite.ir/api/v1/reports

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

curl --location --request POST 'https://checkmysite.ir/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
پارامتر
نوع
توضیحات
url
ضروری string
آدرس وب‌سایت.
privacy
اختیاری integer
حریم خصوصی صفحه گزارش. مقادیر ممکن: 0 برای عمومی, 1 برای خصوصی, 2 برای رمز عبور. پیش‌فرض: 0.
password
اختیاری string
رمزعبور صفحه گزارش. فقط با فیلد privacy تنظیم شده به 2 کار می‌کند.
به‌روزرسانی

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

PUT PATCH 
https://checkmysite.ir/api/v1/reports/{id}

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

curl --location --request PUT 'https://checkmysite.ir/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
توضیحات
privacy
اختیاری integer
حریم خصوصی صفحه گزارش. مقادیر ممکن: 0 برای عمومی, 1 برای خصوصی, 2 برای رمز عبور.
password
اختیاری string
رمزعبور صفحه گزارش. فقط با فیلد privacy تنظیم شده به 2 کار می‌کند.
update
اختیاری integer
به‌روزرسانی. مقادیر ممکن: 0 برای خیر, 1 برای بله. پیش‌فرض: 0.
حذف

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

DELETE 
https://checkmysite.ir/api/v1/reports/{id}

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

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