فضاهای کاری

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

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

GET 
https://5li.ir/api/v1/spaces

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

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

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

GET 
https://5li.ir/api/v1/spaces/{id}

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

curl --location --request GET 'https://5li.ir/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
ذخیره

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

POST 
https://5li.ir/api/v1/spaces

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

curl --location --request POST 'https://5li.ir/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
پارامتر
نوع
توضیحات
name
الزامی string
نام.
color
اختیاری integer
رنگ. مقادیر ممکن عبارتند از: 1, 2, 3, 4, 5, 6. پیش‌فرض: 1.
به‌روزرسانی

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

PUT PATCH 
https://5li.ir/api/v1/spaces/{id}

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

curl --location --request PUT 'https://5li.ir/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
توضیحات
name
اختیاری string
نام.
color
اختیاری integer
رنگ. مقادیر ممکن عبارتند از: 1, 2, 3, 4, 5, 6.
حذف

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

DELETE 
https://5li.ir/api/v1/spaces/{id}

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

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