پروژه‌ها - توسعه‌دهندگان

یادداشت‌ها

Expert level

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

فهرست

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

GET

https://pars.tools/api/v1/projects

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

curl --location --request GET 'https://pars.tools/api/v1/projects' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

پارامتر

نوع

توضیحات

search

اختیاری string

جستجوی عبارت.

search_by

اختیاری string

جستجو بر اساس. مقادیر ممکن هستند: project برای نام. پیش‌فرض: project.

sort_by

اختیاری string

مرتب‌سازی بر اساس. مقادیر ممکن هستند: created_at برای تاریخ ایجاد, project برای نام. پیش‌فرض: created_at.

sort

اختیاری string

مرتب‌سازی. مقادیر ممکن هستند: desc برای نزولی, asc برای صعودی. پیش‌فرض: desc.

per_page

اختیاری integer

نتایج در هر صفحه. مقادیر ممکن هستند: 10, 25, 50, 100. پیش‌فرض: 10.

حذف

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

DELETE

https://pars.tools/api/v1/projects/{project}

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

curl --location --request DELETE 'https://pars.tools/api/v1/projects/{project}' \
--header 'Authorization: Bearer {api_key}'