پیوندها

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

Endpoint در API:

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

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

curl --location --request GET 'https://zaya.io/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
تووضیحات
search
اختیاری string
کوئری جستجو.
by
اختیاری string
جستجو بر اساس. مقادیر قابل استفاده: title برای عنوان, alias برای پیوند یکتا, url برای نشانی.
status
اختیاری integer
Filter by status. مقادیر قابل استفاده: 0 برای همه, 1 برای فعال, 2 برای منقضی شده, 3 برای غیرفعال.
space
اختیاری integer
فیلتر بر اساس id.
domain
اختیاری integer
فیلتر بر اساس id دامنه.
sort
اختیاری string
مرتب سازی بر اساس. مقادیر قابل استفاده: desc برای نزولی, asc برای صعودی, max برای بهترین اجرا, min برای کمترین عملکرد.
نمایش

Endpoint در API:

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

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

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

Endpoint در API:

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

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

curl --location --request POST 'https://zaya.io/api/v1/links' \
--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
موضوع پیوندی است که باید در زیر آن ذخیره شود.
domain
اختیاری integer
دامنه ای که می بایست در زیر آن ساخته شود.
disabled
اختیاری integer
بررسی می کند که آیا لینک فعال است یا غیر فعال. مقدار پیشفرض: 0.
public
اختیاری integer
بررسی می کند که آمار لینک عمومی است یا شخصی. مقدار پیشفرض: 0.
expiration_url
اختیاری string
پیوندی که بعد از منقضی شدن لینک، کاربران به آن هدایت می شوند.
expiration_date
اختیاری string
تاریخ انقضاء لینک در فرمت YYYY-MM-DD .
expiration_time
اختیاری string
زمان انقضاء لینک در فرمت HH:MM .
expiration_clicks
اختیاری integer
تعداد کلیک هایی که پس از آن باید لینک منقضی شود.
target_type
اختیاری integer
تعیین نوع هدفگیری. مقادیر قابل استفاده: 0 برای انتخاب نشده, 1 برای جغرافیایی, 2 برای انتخاب پلتفرم, 3 برای چرخش لینک.
geo[index][key]
اختیاری string
کد کشور انتخابی می بایست با استاندارد ISO 3166-1 alpha-2 وارد شود.
geo[index][value]
اختیاری string
پیوند کشوری که کاربر به آن هدایت می شود.
platform[index][key]
اختیاری string
نام پلتفرم مورد هدف. مقادیر قابل استفاده: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
اختیاری string
پیوند بسترهای نرم افزاری که کاربر به آن هدایت می شود.
rotation[index][value]
اختیاری string
پیوند چرخشی که کاربر به آن هدایت می شود.
بروزرسانی

Endpoint در API:

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

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

curl --location --request PUT 'https://zaya.io/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
موضوع پیوندی است که باید در زیر آن ذخیره شود.
domain
اختیاری integer
دامنه ای که می بایست در زیر آن ساخته شود.
disabled
اختیاری integer
بررسی می کند که آیا لینک فعال است یا غیر فعال. مقدار پیشفرض: 0.
public
اختیاری integer
بررسی می کند که آمار لینک عمومی است یا شخصی. مقدار پیشفرض: 0.
expiration_url
اختیاری string
پیوندی که بعد از منقضی شدن لینک، کاربران به آن هدایت می شوند.
expiration_date
اختیاری string
تاریخ انقضاء لینک در فرمت YYYY-MM-DD .
expiration_time
اختیاری string
زمان انقضاء لینک در فرمت HH:MM .
expiration_clicks
اختیاری integer
تعداد کلیک هایی که پس از آن باید لینک منقضی شود.
target_type
اختیاری integer
تعیین نوع هدفگیری. مقادیر قابل استفاده: 0 برای انتخاب نشده, 1 برای جغرافیایی, 2 برای انتخاب پلتفرم, 3 برای چرخش لینک.
geo[index][key]
اختیاری string
کد کشور انتخابی می بایست با استاندارد ISO 3166-1 alpha-2 وارد شود.
geo[index][value]
اختیاری string
پیوند کشوری که کاربر به آن هدایت می شود.
platform[index][key]
اختیاری string
نام پلتفرم مورد هدف. مقادیر قابل استفاده: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
اختیاری string
پیوند بسترهای نرم افزاری که کاربر به آن هدایت می شود.
rotation[index][value]
اختیاری string
پیوند چرخشی که کاربر به آن هدایت می شود.
حذف

Endpoint در API:

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

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

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