پیوندها

یادداشت

سطح کارشناسی

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

فهرست کنید

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

GET

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

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

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

پارامتر

تایپ کنید

شرح

search

اختیاری string

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

by

اختیاری string

جستجو بر اساس. مقادیر ممکن عبارتند از: title برای عنوان, alias برای نام مستعار, url برای URL. پیش‌فرض: title.

status

اختیاری integer

فیلتر بر اساس وضعیت مقادیر ممکن عبارتند از: 0 برای همه, 1 برای فعال, 2 برای منقضی شده, 3 برای معلول. پیش‌فرض: 0.

space

اختیاری integer

فیلتر بر اساس شناسه فاصله

domain

اختیاری integer

فیلتر بر اساس شناسه دامنه

pixel

اختیاری integer

فیلتر بر اساس شناسه پیکسل.

sort

اختیاری string

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

per_page

اختیاری int

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

نمایش دهید

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

GET

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

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

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

فروشگاه

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

POST

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

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

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

پارامتر

تایپ کنید

شرح

url

ضروری string

لینک کوتاه شود

domain

ضروری integer

شناسه دامنه پیوندی که باید در آن ذخیره شود.

alias

اختیاری string

نام مستعار پیوند.

password

اختیاری string

رمز عبور لینک

space

اختیاری integer

شناسه فاصله پیوندی که باید در آن ذخیره شود.

pixels

اختیاری array

The pixel IDs to be integrated in the link.

disabled

اختیاری integer

این که آیا لینک غیرفعال است یا خیر. مقادیر ممکن عبارتند از: 0 برای فعال, 1 برای معلول. پیش‌فرض: 0.

privacy

اختیاری integer

اینکه آیا آمار پیوند عمومی است یا نه. مقادیر ممکن عبارتند از: 0 برای عمومی, 1 برای خصوصی, 2 برای کلمه عبور. پیش‌فرض: 0.

privacy_password

اختیاری string

رمز عبور صفحه آمار فقط با فیلد که روی 2 تنظیم شده است کار می کند.

expiration_url

اختیاری string

پیوندی که پس از منقضی شدن پیوند، کاربر به آنجا هدایت می شود.

expiration_date

اختیاری string

تاریخ انقضای لینک با فرمت :.

expiration_time

اختیاری string

زمان انقضای لینک با فرمت :

expiration_clicks

اختیاری integer

تعداد کلیک هایی که پس از آن پیوند باید منقضی شود.

target_type

اختیاری integer

نوع هدف گذاری مقادیر ممکن عبارتند از: 0 برای هیچ یک, 1 برای جغرافیایی, 2 برای سکو, 4 برای چرخش.

country[index][key]

اختیاری string

کد کشور مورد نظر کد باید در استاندارد :استاندارد باشد.

country[index][value]

اختیاری string

پیوندی که کاربر به آن هدایت می شود.

platform[index][key]

اختیاری string

نام پلت فرم مورد نظر. مقادیر ممکن عبارتند از: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.

platform[index][value]

اختیاری string

پیوندی که کاربر به آن هدایت می شود.

language[index][key]

اختیاری string

کد زبان مورد نظر کد باید در استاندارد :استاندارد باشد.

language[index][value]

اختیاری string

پیوندی که کاربر به آن هدایت می شود.

rotation[index][value]

اختیاری string

پیوندی که کاربر به آن هدایت می شود.

به روز رسانی

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

PUT PATCH

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

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

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

پارامتر

تایپ کنید

شرح

url

اختیاری string

لینک کوتاه شود

alias

اختیاری string

نام مستعار پیوند.

password

اختیاری string

رمز عبور لینک

space

اختیاری integer

شناسه فاصله پیوندی که باید در آن ذخیره شود.

pixels

اختیاری array

The pixel IDs to be integrated in the link.

disabled

اختیاری integer

این که آیا لینک غیرفعال است یا خیر. مقادیر ممکن عبارتند از: 0 برای فعال, 1 برای معلول.

privacy

اختیاری integer

اینکه آیا آمار پیوند عمومی است یا نه. مقادیر ممکن عبارتند از: 0 برای عمومی, 1 برای خصوصی, 2 برای کلمه عبور.

privacy_password

اختیاری string

رمز عبور صفحه آمار فقط با فیلد که روی 2 تنظیم شده است کار می کند.

expiration_url

اختیاری string

پیوندی که پس از منقضی شدن پیوند، کاربر به آنجا هدایت می شود.

expiration_date

اختیاری string

تاریخ انقضای لینک با فرمت :.

expiration_time

اختیاری string

زمان انقضای لینک با فرمت :

expiration_clicks

اختیاری integer

تعداد کلیک هایی که پس از آن پیوند باید منقضی شود.

target_type

اختیاری integer

نوع هدف گذاری مقادیر ممکن عبارتند از: 0 برای هیچ یک, 1 برای جغرافیایی, 2 برای سکو, 4 برای چرخش.

country[index][key]

اختیاری string

کد کشور مورد نظر کد باید در استاندارد :استاندارد باشد.

country[index][value]

اختیاری string

پیوندی که کاربر به آن هدایت می شود.

platform[index][key]

اختیاری string

نام پلت فرم مورد نظر. مقادیر ممکن عبارتند از: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.

platform[index][value]

اختیاری string

پیوندی که کاربر به آن هدایت می شود.

language[index][key]

اختیاری string

کد زبان مورد نظر کد باید در استاندارد :استاندارد باشد.

language[index][value]

اختیاری string

پیوندی که کاربر به آن هدایت می شود.

rotation[index][value]

اختیاری string

پیوندی که کاربر به آن هدایت می شود.

حذف

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

DELETE

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

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

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