موضوعات

یادداشت
سطح حرفه ای
جهت اتصال به endpoint در سیستم API، می بایست از کلید آن استفاده کنید. کلید API خود را دریافت کنید.
لیست

Endpoint در API:

GET
https://zaya.io/api/v1/spaces

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

curl --location --request GET 'https://zaya.io/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
تووضیحات
search
اختیاری string
کوئری جستجو.
sort
اختیاری string
مرتب سازی بر اساس. مقادیر قابل استفاده: desc برای نزولی, asc برای صعودی.
نمایش

Endpoint در API:

GET
https://zaya.io/api/v1/spaces/{id}

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

curl --location --request GET 'https://zaya.io/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
ساخت

Endpoint در API:

POST
https://zaya.io/api/v1/spaces

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

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

Endpoint در API:

PUT PATCH
https://zaya.io/api/v1/spaces/{id}

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

curl --location --request PUT 'https://zaya.io/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
کد رنگ موضوع. مقادیر قابل استفاده: 1, 2, 3, 4, 5, 6.
حذف

Endpoint در API:

DELETE
https://zaya.io/api/v1/spaces/{id}

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

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