مساحات

ملاحظات
مستوى الخبراء
يجب إرسال مفتاح واجهة برمجة التطبيقات كرمز لحامله في رأس التفويض الخاص بالطلب. احصل على مفتاح واجهة برمجة تطبيقات الخاص بك.
قائمة

نقطة النهاية واجهة برمجة تطبيقات:

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
استعلام البحث.
sort
اختياري string
فرز. القيم الممكنة هي :القيم. افتراضات إلى :القيمة.
per_page
اختياري int
النتائج لكل صفحه. القيم الممكنة هي :القيم. افتراضات إلى :القيمة.
عرض

نقطة النهاية واجهة برمجة تطبيقات:

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}'
محل

نقطة النهاية واجهة برمجة تطبيقات:

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 'url={url}'
معامل
النوع
وصف
name
مطلوب string
اسم المساحة.
color
اختياري integer
رمز اللون. القيم الممكنة هي :القيم. افتراضات إلى :القيمة.
تحديث

نقطة النهاية واجهة برمجة تطبيقات:

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}' \
--data-urlencode 'url={url}'
معامل
النوع
وصف
name
اختياري string
اسم المساحة.
color
اختياري integer
رمز اللون. القيم الممكنة هي :القيم.
مسح

نقطة النهاية واجهة برمجة تطبيقات:

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

طلب مثال: 

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