دامنه ها

یادداشت

سطح کارشناسی

کلید API باید به عنوان یک توکن حامل در هدر مجوز درخواست ارسال شود. کلید API خود را دریافت کنید.

فهرست کنید

نقطه پایانی API:

GET

https://akoo.ir/api/v1/domains

درخواست نمونه:

curl --location --request GET 'https://akoo.ir/api/v1/domains' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

پارامتر

تایپ کنید

شرح

search

اختیاری string

پرس و جوی جستجو

sort

اختیاری string

مرتب سازی. مقادیر ممکن عبارتند از: desc برای نزولی, asc برای صعودی. پیش‌فرض: desc.

per_page

اختیاری int

نتایج در هر صفحه. مقادیر ممکن عبارتند از: :از به :به. پیش‌فرض: 10.

نمایش دهید

نقطه پایانی API:

GET

https://akoo.ir/api/v1/domains/{id}

درخواست نمونه:

curl --location --request GET 'https://akoo.ir/api/v1/domains/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

فروشگاه

نقطه پایانی API:

POST

https://akoo.ir/api/v1/domains

درخواست نمونه:

curl --location --request POST 'https://akoo.ir/api/v1/domains' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'

پارامتر

تایپ کنید

شرح

name

ضروری string

نام فضا

index_page

اختیاری string

صفحه فهرست برای تغییر مسیر.

not_found_page

اختیاری string

صفحه 404 برای تغییر مسیر.

به روز رسانی

نقطه پایانی API:

PUT PATCH

https://akoo.ir/api/v1/domains/{id}

درخواست نمونه:

curl --location --request PUT 'https://akoo.ir/api/v1/domains/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'

پارامتر

تایپ کنید

شرح

index_page

اختیاری string

صفحه فهرست برای تغییر مسیر.

not_found_page

اختیاری string

صفحه 404 برای تغییر مسیر.

حذف

نقطه پایانی API:

DELETE

https://akoo.ir/domains/{id}/destroy

درخواست نمونه:

curl --location --request DELETE 'https://akoo.ir/domains/{id}/destroy' \
--header 'Authorization: Bearer {api_key}'