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

یادداشت‌ها

Expert level

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

فهرست

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

GET

https://seo.yunex.ir/api/v1/projects

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

curl --location --request GET 'https://seo.yunex.ir/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://seo.yunex.ir/api/v1/projects/{project}

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

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