المساحات

ملاحظات
مستوى خبير
مفتاح API لازم يترسل كـ Bearer token في رأس الطلب Authorization. خذ مفتاح API بتاعك.
قائمة

نقطة نهاية API:

GET 
https://shbbr.com/api/v1/spaces

مثال الطلب: 

curl --location --request GET 'https://shbbr.com/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. الافتراضي: 100.
عرض

نقطة نهاية API:

GET 
https://shbbr.com/api/v1/spaces/{id}

مثال الطلب: 

curl --location --request GET 'https://shbbr.com/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
تخزين

نقطة نهاية API:

POST 
https://shbbr.com/api/v1/spaces

مثال الطلب: 

curl --location --request POST 'https://shbbr.com/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://shbbr.com/api/v1/spaces/{id}

مثال الطلب: 

curl --location --request PUT 'https://shbbr.com/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://shbbr.com/api/v1/spaces/{id}

مثال الطلب: 

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