العلامات

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

نقطة نهاية API:

GET 
https://kilo.site/api/v1/spaces

طلب مثال: 

curl --location --request GET 'https://kilo.site/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
المقياس
نوع
الوصف
search
اختياري string
استعلام البحث.
search_by
اختياري string
البحث عن طريق. القيم الممكنة هي: :قيمة لـ الاسم. الإعدادات الافتراضية إلى: name.
sort_by
اختياري string
ترتيب حسب. القيم الممكنة هي: :قيمة لـ تاريخ الإنشاء, :قيمة لـ الاسم. الإعدادات الافتراضية إلى: id.
sort
اختياري string
نوع. القيم الممكنة هي: :قيمة لـ تنازلي, :قيمة لـ تصاعدي. الإعدادات الافتراضية إلى: desc.
per_page
اختياري int
النتائج لكل صفحة. القيم الممكنة هي: 10, 25, 50, 100. الإعدادات الافتراضية إلى: 10.
مشاهده

نقطة نهاية API:

GET 
https://kilo.site/api/v1/spaces/{id}

طلب مثال: 

curl --location --request GET 'https://kilo.site/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
متجر

نقطة نهاية API:

POST 
https://kilo.site/api/v1/spaces

طلب مثال: 

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

طلب مثال: 

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

طلب مثال: 

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