المساحات

المصادقة
يجب إرسال مفتاح API كرمز Bearer في ترويسة Authorization الخاصة بالطلب. احصل على مفتاح API الخاص بك.
قائمة

نقطة نهاية API

GET 
https://dx.sa/api/v1/spaces

مثال على الطلب 

curl --location --request GET 'https://dx.sa/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

المعاملات (Parameters)

الاسم
النوع
الوصف
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://dx.sa/api/v1/spaces/{id}

مثال على الطلب 

curl --location --request GET 'https://dx.sa/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
حفظ

نقطة نهاية API

POST 
https://dx.sa/api/v1/spaces

مثال على الطلب 

curl --location --request POST 'https://dx.sa/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'

المعاملات (Parameters)

الاسم
النوع
الوصف
name
مطلوب string
الاسم.
color
اختياري integer
اللون. القيم الممكنة هي: 1, 2, 3, 4, 5, 6. القيمة الافتراضية هي: 1.
تحديث

نقطة نهاية API

PUT PATCH 
https://dx.sa/api/v1/spaces/{id}

مثال على الطلب 

curl --location --request PUT 'https://dx.sa/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

المعاملات (Parameters)

الاسم
النوع
الوصف
name
اختياري string
الاسم.
color
اختياري integer
اللون. القيم الممكنة هي: 1, 2, 3, 4, 5, 6.
حذف

نقطة نهاية API

DELETE 
https://dx.sa/api/v1/spaces/{id}

مثال على الطلب 

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