گزارش‌ها

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

نشانی رابط برنامه‌نویسی:

GET 
https://payesha.ariyaweb.net/api/v1/reports

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

curl --location --request GET 'https://payesha.ariyaweb.net/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
توضیحات
search
اختیاری string
عبارت جست‌وجو.
search_by
اختیاری string
جستجو بر اساس. مقدارهای مجاز: url برای آدرس اینترنتی. مقدار پیش‌فرض: url.
project
اختیاری 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.
نمایش

نشانی رابط برنامه‌نویسی:

GET 
https://payesha.ariyaweb.net/api/v1/reports/{id}

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

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

نشانی رابط برنامه‌نویسی:

POST 
https://payesha.ariyaweb.net/api/v1/reports

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

curl --location --request POST 'https://payesha.ariyaweb.net/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 تنظیم شده باشد.
به‌روزرسانی

نشانی رابط برنامه‌نویسی:

PUT PATCH 
https://payesha.ariyaweb.net/api/v1/reports/{id}

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

curl --location --request PUT 'https://payesha.ariyaweb.net/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.
حذف

نشانی رابط برنامه‌نویسی:

DELETE 
https://payesha.ariyaweb.net/api/v1/reports/{id}

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

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